Class AngularFrameworkComponentFactory

Index

Constructors

Methods

createDockviewComponent createGridviewComponent createHeaderActionsComponent createPaneviewComponent createSplitviewComponent createTabComponent createWatermarkComponent updateComponents

Constructors

constructor

new AngularFrameworkComponentFactory(
    components: Record<string, Type<any> | TemplateRef<any>>,
    injector: Injector,
    environmentInjector?: EnvironmentInjector,
    tabComponents?: Record<string, Type<any> | TemplateRef<any>>,
    watermarkComponent?: Type<any> | TemplateRef<any>,
    headerActionsComponents?: Record<string, Type<any> | TemplateRef<any>>,
    defaultTabComponent?: Type<any> | TemplateRef<any>,
): AngularFrameworkComponentFactory
Parameters
- components: Record<string, Type<any> | TemplateRef<any>>
- injector: Injector
- OptionalenvironmentInjector: EnvironmentInjector
- OptionaltabComponents: Record<string, Type<any> | TemplateRef<any>>
- OptionalwatermarkComponent: Type<any> | TemplateRef<any>
- OptionalheaderActionsComponents: Record<string, Type<any> | TemplateRef<any>>
- OptionaldefaultTabComponent: Type<any> | TemplateRef<any>
Returns AngularFrameworkComponentFactory
- Defined in utils/component-factory.ts:25

Methods

createDockviewComponent

createDockviewComponent(options: CreateComponentOptions): IContentRenderer
Parameters
- options: CreateComponentOptions
Returns IContentRenderer
- Defined in utils/component-factory.ts:58

createGridviewComponent

createGridviewComponent(options: CreateComponentOptions): GridviewPanel
Parameters
- options: CreateComponentOptions
Returns GridviewPanel
- Defined in utils/component-factory.ts:76

createHeaderActionsComponent

createHeaderActionsComponent(
name: string,
group: DockviewGroupPanel,
): IHeaderActionsRenderer | undefined
Parameters
- name: string
- group: DockviewGroupPanel
Returns IHeaderActionsRenderer | undefined
- Defined in utils/component-factory.ts:163

createPaneviewComponent

createPaneviewComponent(options: CreateComponentOptions): IPanePart
Parameters
- options: CreateComponentOptions
Returns IPanePart
- Defined in utils/component-factory.ts:110

createSplitviewComponent

createSplitviewComponent(options: CreateComponentOptions): SplitviewPanel
Parameters
- options: CreateComponentOptions
Returns SplitviewPanel
- Defined in utils/component-factory.ts:93

createTabComponent

createTabComponent(options: CreateComponentOptions): ITabRenderer | undefined
Parameters
- options: CreateComponentOptions
Returns ITabRenderer | undefined
- Defined in utils/component-factory.ts:125

createWatermarkComponent

createWatermarkComponent(): IWatermarkRenderer
Returns IWatermarkRenderer
- Defined in utils/component-factory.ts:148

updateComponents

updateComponents(
    maps: {
        components: Record<string, Type<any> | TemplateRef<any>>;
        defaultTabComponent?: Type<any> | TemplateRef<any>;
        headerActionsComponents?: Record<string, Type<any> | TemplateRef<any>>;
        tabComponents?: Record<string, Type<any> | TemplateRef<any>>;
        watermarkComponent?: Type<any> | TemplateRef<any>;
    },
): void
Refresh the component maps in place so that rebinding an @Input() component map (e.g. [components]) after init is honoured. The core calls the factory live on each panel creation, so updating these references is enough. No re-init required.
Parameters
- maps: {
      components: Record<string, Type<any> | TemplateRef<any>>;
      defaultTabComponent?: Type<any> | TemplateRef<any>;
      headerActionsComponents?: Record<string, Type<any> | TemplateRef<any>>;
      tabComponents?: Record<string, Type<any> | TemplateRef<any>>;
      watermarkComponent?: Type<any> | TemplateRef<any>;
  }
Returns void
- Defined in utils/component-factory.ts:44