Member Junction
    Preparing search index...

    Angular component that hosts React components with proper memory management. This component provides a bridge between Angular and React, allowing React components to be used seamlessly within Angular applications.

    Hierarchy (View Summary)

    Implements

    • AfterViewInit
    • OnDestroy
    Index

    Constructors

    Properties

    componentEvent: EventEmitter<ReactComponentEvent> = ...

    Use ComponentEvent.

    The same emitter under the old binding name, so a template still binding (componentEvent) keeps working. Must stay AFTER ComponentEvent: class fields initialise in order, and the other way round this captures undefined.

    ComponentEvent: EventEmitter<ReactComponentEvent> = ...
    Container: ElementRef<HTMLDivElement>
    EnableLogging: boolean = false

    Controls verbose logging for component lifecycle and operations. Note: This does NOT control which React build (dev/prod) is loaded. To control React builds, use ReactDebugConfig.setDebugMode() at app startup.

    HasError: boolean = false
    initialized: EventEmitter<void> = ...

    Use Initialized.

    The same emitter under the old binding name, so a template still binding (initialized) keeps working. Must stay AFTER Initialized: class fields initialise in order, and the other way round this captures undefined.

    Initialized: EventEmitter<void> = ...

    Emitted once after the component successfully loads and resolvedComponentSpec is populated.

    IsInitialized: boolean = false
    openEntityRecord: EventEmitter<{ entityName: string; key: CompositeKey }> = ...

    Use OpenEntityRecord.

    The same emitter under the old binding name, so a template still binding (openEntityRecord) keeps working. Must stay AFTER OpenEntityRecord: class fields initialise in order, and the other way round this captures undefined.

    OpenEntityRecord: EventEmitter<{ entityName: string; key: CompositeKey }> = ...
    PersistUserSettings: boolean = true

    When true (default), the host transparently persists savedUserSettings per-user, cross-device via UserInfoEngine — seeding the component from storage on load and saving (debounced) on every onSaveUserSettings call, auto-scoped per component. Set to false to opt out and own persistence yourself by handling the userSettingsChanged output instead.

    Provider: IMetadataProvider | null

    If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

    refreshData: EventEmitter<void> = ...

    Use RefreshData.

    The same emitter under the old binding name, so a template still binding (refreshData) keeps working. Must stay AFTER RefreshData: class fields initialise in order, and the other way round this captures undefined.

    RefreshData: EventEmitter<void> = ...
    ResolvedComponentSpec: ComponentSpec | null = null

    Public property containing the fully resolved component specification. This includes all external code fetched from registries, allowing consumers to inspect the complete resolved specification including dependencies. Only populated after successful component initialization.

    stateChange: EventEmitter<StateChangeEvent> = ...

    Use StateChange.

    The same emitter under the old binding name, so a template still binding (stateChange) keeps working. Must stay AFTER StateChange: class fields initialise in order, and the other way round this captures undefined.

    StateChange: EventEmitter<StateChangeEvent> = ...
    UseComponentManager: boolean = true
    userSettingsChanged: EventEmitter<UserSettingsChangedEvent> = ...

    Use UserSettingsChanged.

    The same emitter under the old binding name, so a template still binding (userSettingsChanged) keeps working. Must stay AFTER UserSettingsChanged: class fields initialise in order, and the other way round this captures undefined.

    UserSettingsChanged: EventEmitter<UserSettingsChangedEvent> = ...
    UserStateScope?: string

    Optional explicit scope for per-user settings persistence. When omitted, the scope defaults to <namespace>/<name> of the component spec. Settings are stored per-user via UserInfoEngine under the key InteractiveComponents_UserState_Root/<scope>. Provide an explicit scope when a single component spec is rendered in multiple distinct contexts that should NOT share preferences (e.g. the same form spec used for different entities) — set it to something stable and unique per context.

    "ɵdir": unknown
    "ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

    Accessors

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    Methods

    • Invokes a custom method on the component

      Parameters

      • methodName: string

        Name of the method to invoke

      • ...args: any[]

        Arguments to pass to the method

      Returns any

      The result of the method call, or undefined if method doesn't exist

    • A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

      Returns Promise<void>

    • Refreshes the component: calls the component's own refresh() when it registered one, otherwise re-renders it. Hosts that drive a component from outside (an agent operating it through a realtime channel) use this; a component that manages its own data does not need it.

      Returns void

    • Scrolls to a specific element or position within the component

      Parameters

      • target: string | HTMLElement | { left?: number; top?: number }

        Element selector, element reference, or scroll options

      Returns void