ViewContainerRef
class
Represents a container where one or more views can be attached to a component.
abstract class ViewContainerRef {
abstract element: ElementRef
abstract injector: Injector
abstract parentInjector: Injector
abstract length: number
abstract clear(): void
abstract get(index: number): ViewRef | null
abstract createEmbeddedView<C>(templateRef: TemplateRef<C>, context?: C, index?: number): EmbeddedViewRef<C>
abstract createComponent<C>(componentFactory: ComponentFactory<C>, index?: number, injector?: Injector, projectableNodes?: any[][], ngModule?: NgModuleRef<any>): ComponentRef<C>
abstract insert(viewRef: ViewRef, index?: number): ViewRef
abstract move(viewRef: ViewRef, currentIndex: number): ViewRef
abstract indexOf(viewRef: ViewRef): number
abstract remove(index?: number): void
abstract detach(index?: number): ViewRef | null
}
See also
ComponentRef
EmbeddedViewRef
Description
Can contain host views (created by instantiating a component with the createComponent()
method), and embedded views (created by instantiating a TemplateRef
with the createEmbeddedView()
method).
A view container instance can contain other view containers, creating a view hierarchy.
Properties
Property | Description |
---|---|
abstract element: ElementRef
|
Read-Only 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 |
abstract injector: Injector
|
Read-Only The dependency injector for this view container. |
abstract parentInjector: Injector
|
Read-Only |
abstract length: number
|
Read-Only Reports how many views are currently attached to this container. |
Methods
clear() |
---|
Destroys all views in this container. |
abstract clear(): voidParametersThere are no parameters. Returns
|
get() | |||
---|---|---|---|
Retrieves a view from this container. | |||
abstract get(index: number): ViewRef | nullParameters
Returns
|
createEmbeddedView() | |||||||||
---|---|---|---|---|---|---|---|---|---|
Instantiates an embedded view and inserts it into this container. | |||||||||
abstract createEmbeddedView<C>(templateRef: TemplateRef<C>, context?: C, index?: number): EmbeddedViewRef<C>Parameters
Returns
|
createComponent() | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Instantiates a single component and inserts its host view into this container. | |||||||||||||||
abstract createComponent<C>(componentFactory: ComponentFactory<C>, index?: number, injector?: Injector, projectableNodes?: any[][], ngModule?: NgModuleRef<any>): ComponentRef<C>Parameters
Returns
|
insert() | ||||||
---|---|---|---|---|---|---|
Inserts a view into this container. | ||||||
abstract insert(viewRef: ViewRef, index?: number): ViewRefParameters
Returns
|
move() | ||||||
---|---|---|---|---|---|---|
Moves a view to a new location in this container. | ||||||
abstract move(viewRef: ViewRef, currentIndex: number): ViewRefParameters
Returns
|
indexOf() | |||
---|---|---|---|
Returns the index of a view within the current container. | |||
abstract indexOf(viewRef: ViewRef): numberParameters
Returns
|
remove() | |||
---|---|---|---|
Destroys a view attached to this container | |||
abstract remove(index?: number): voidParameters
Returns
|
detach() | |||
---|---|---|---|
Detaches a view from this container without destroying it. Use along with insert() to move a view within the current container.
| |||
abstract detach(index?: number): ViewRef | nullParameters
Returns
|
© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v9.angular.io/api/core/ViewContainerRef