Class ViewContainerRef`Abstract`

Hierarchy (View Summary)

ViewContainerRef
- ViewContainerRefImpl

Index

Constructors

constructor

new ViewContainerRef(): ViewContainerRef
Returns ViewContainerRef

Accessors

`Abstract`anchorElement

get anchorElement(): Element
Anchor element that specifies the location of this container in the containing view. Each view container can have only one anchor element, and each anchor element can have only a single view container.

Root elements of views attached to this container become siblings of the anchor element in the rendered view.

Access the ViewContainerRef of an element by placing a Directive injected with ViewContainerRef on the element, or use a ViewChild query.

Returns Element
- Defined in git/aurora/src/core/linker/view-container-ref.ts:47

`Abstract`length

get length(): number
Reports how many views are currently attached to this container.

Returns number
The number of views.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:65

Methods

`Abstract`clear

clear(): void
Destroys all views in this container.

Returns void
- Defined in git/aurora/src/core/linker/view-container-ref.ts:52

`Abstract`createComponent

createComponent<C extends {}>(selector: string, options?: IndexOptions): C
create component by tag name selector.
Type Parameters
- C extends {}
Parameters
- selector: string
  the tag name for the aurora custom-element
- Optionaloptions: IndexOptions
Returns C
- Defined in git/aurora/src/core/linker/view-container-ref.ts:85
createComponent<C extends {}>(
viewClass: Type<HTMLComponent<C>>,
options?: IndexOptions,
): C
create component by the aurora custom-element View Class
Type Parameters
- C extends {}
Parameters
- viewClass: Type<HTMLComponent<C>>
  the generated aurora view class
- Optionaloptions: IndexOptions
Returns C
- Defined in git/aurora/src/core/linker/view-container-ref.ts:92
createComponent<C extends {}>(
componentType: Type<C>,
options?: ViewContainerComponentOptions,
): C
Instantiates a single component and inserts its host view into this container.
Type Parameters
- C extends {}
Parameters
- componentType: Type<C>
  Component Type to use.
- Optionaloptions: ViewContainerComponentOptions
  An object that contains extra parameters:
  - index: the index at which to insert the new component's host view into this container. If not specified, appends the new view as the last entry.
  - selector: the tag name of the new create component that attached with this model class. Any Model class can have many views with different selectors.
Returns C
The new HTMLComponent which contains the component instance and the host view.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:106

`Abstract`createElement

createElement<K extends keyof HTMLElementTagNameMap>(
selector: K,
options?: HTMLElementOptions,
): HTMLElementTagNameMap[K]
create an HTMLElement by tag name selector.
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selector: K
  the tag name for the aurora custom-element
- Optionaloptions: HTMLElementOptions
Returns HTMLElementTagNameMap[K]
- Defined in git/aurora/src/core/linker/view-container-ref.ts:113
createElement<K extends keyof HTMLElementDeprecatedTagNameMap>(
selector: K,
options?: HTMLElementOptions,
): HTMLElementDeprecatedTagNameMap[K]
create an HTMLElement by tag name selector.
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selector: K
  the tag name for the aurora custom-element
- Optionaloptions: HTMLElementOptions
Returns HTMLElementDeprecatedTagNameMap[K]
- Defined in git/aurora/src/core/linker/view-container-ref.ts:114
createElement<C extends HTMLElement>(
htmlElementClass: Type<C>,
options?: HTMLElementOptions,
): C
create HTMLElement by View Class reference
Type Parameters
- C extends HTMLElement
Parameters
- htmlElementClass: Type<C>
- Optionaloptions: HTMLElementOptions
Returns C
- Defined in git/aurora/src/core/linker/view-container-ref.ts:121

`Abstract`createEmbeddedView

createEmbeddedView<C extends {}>(
templateRef: TemplateRef,
options?: ViewContainerOptions<C>,
): EmbeddedViewRef<C>
Instantiates an embedded view and inserts it into this container.
Type Parameters
- C extends {}
Parameters
- templateRef: TemplateRef
  The HTML template that defines the view.
- Optionaloptions: ViewContainerOptions<C>
Returns EmbeddedViewRef<C>
The ViewRef instance for the newly created view.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:78

`Abstract`createTextNode

createTextNode(data: string, options?: IndexOptions): Text
create a text node and insert to the view
Parameters
- data: string
- Optionaloptions: IndexOptions
Returns Text
- Defined in git/aurora/src/core/linker/view-container-ref.ts:128

`Abstract`detach

detach(index?: number): undefined | ViewRef
Detaches a view from this container without destroying it. Use along with insert() to move a view within the current container.
Parameters
- Optionalindex: number
  The 0-based index of the view to detach. If not specified, the last view in the container is detached.
Returns undefined | ViewRef
- Defined in git/aurora/src/core/linker/view-container-ref.ts:169

`Abstract`get

get(index: number): undefined | ViewRef
Retrieves a view from this container.
Parameters
- index: number
  The 0-based index of the view to retrieve.
Returns undefined | ViewRef
The ViewRef instance, or null if the index is out of range.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:59

`Abstract`indexOf

indexOf(viewRef: ViewRef): number
Returns the index of a view within the current container.
Parameters
- viewRef: ViewRef
  The view to query.
Returns number
The 0-based index of the view's position in this container, or -1 if this container doesn't contain the view.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:154

`Abstract`insert

insert(viewRef: ViewRef, index?: number): ViewRef
Inserts a view into this container.
Parameters
- viewRef: ViewRef
  The view to insert.
- Optionalindex: number
  The 0-based index at which to insert the view. If not specified, appends the new view as the last entry.
Returns ViewRef
The inserted ViewRef instance.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:138

`Abstract`move

move(viewRef: ViewRef, newIndex: number): ViewRef
Moves a view to a new location in this container.
Parameters
- viewRef: ViewRef
  The view to move.
- newIndex: number
  The 0-based index of the new location.
Returns ViewRef
The moved ViewRef instance.
- Defined in git/aurora/src/core/linker/view-container-ref.ts:146

`Abstract`remove

remove(index?: number): void
Destroys a view attached to this container
Parameters
- Optionalindex: number
  The 0-based index of the view to destroy. If not specified, the last view in the container is removed.
Returns void
- Defined in git/aurora/src/core/linker/view-container-ref.ts:161

`Abstract`updateViews

updateViews(views: ViewRef[]): void
set the current views from this
Parameters
- views: ViewRef[]
  the new ViewRef list
Returns void
- Defined in git/aurora/src/core/linker/view-container-ref.ts:175

Class ViewContainerRefAbstract

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns ViewContainerRef

Accessors

AbstractanchorElement

Returns Element

Abstractlength

Returns number

Methods

Abstractclear

Returns void

AbstractcreateComponent

Type Parameters

Parameters

Returns C

Type Parameters

Parameters

Returns C

Type Parameters

Parameters

Returns C

AbstractcreateElement

Type Parameters

Parameters

Returns HTMLElementTagNameMap[K]

Type Parameters

Parameters

Returns HTMLElementDeprecatedTagNameMap[K]

Type Parameters

Parameters

Returns C

AbstractcreateEmbeddedView

Type Parameters

Parameters

Returns EmbeddedViewRef<C>

AbstractcreateTextNode

Parameters

Returns Text

Abstractdetach

Parameters

Returns undefined | ViewRef

Abstractget

Parameters

Returns undefined | ViewRef

AbstractindexOf

Parameters

Returns number

Abstractinsert

Parameters

Returns ViewRef

Abstractmove

Parameters

Returns ViewRef

Abstractremove

Parameters

Returns void

AbstractupdateViews

Parameters

Returns void

Settings

On This Page

Class ViewContainerRef`Abstract`

`Abstract`anchorElement

`Abstract`length

`Abstract`clear

`Abstract`createComponent

`Abstract`createElement

`Abstract`createEmbeddedView

`Abstract`createTextNode

`Abstract`detach

`Abstract`get

`Abstract`indexOf

`Abstract`insert

`Abstract`move

`Abstract`remove

`Abstract`updateViews