Class MjRecordPreviewPopoverComponent

Lightweight hover preview card (<mj-record-preview-popover>) that displays key metadata and summary fields (DefaultInView) for any foreign-key or polymorphic-FK linked record.

Pluggable via `@RegisterClass` and `MJGlobal.Instance.ClassFactory`

Applications and domain packages can subclass MjRecordPreviewPopoverComponent and register their custom hover card with @RegisterClass:

Global replacement (all entities): @RegisterClass(MjRecordPreviewPopoverComponent) or @RegisterClass(MjRecordPreviewPopoverComponent, '*')
Schema or wildcard replacement: @RegisterClass(MjRecordPreviewPopoverComponent, 'MJ_BizApps_Common:*') or @RegisterClass(MjRecordPreviewPopoverComponent, 'schema:mj_bizapps_common')
Entity-specific replacement: @RegisterClass(MjRecordPreviewPopoverComponent, 'MJ_BizApps_Common: People')

MjRecordPreviewPopoverService calls ResolveRecordPreviewPopoverType at runtime to instantiate the highest-priority matching subclass via Angular's createComponent().

Hierarchy (View Summary)

BaseAngularComponent
- MjRecordPreviewPopoverComponent

Implements

OnDestroy

Index

Constructors

constructor

Accessors

AnchorRect CompactRecordID DisplayName EntityName PopoverPositionStyle PrimaryKey ProviderToUse RecordID RunQueryToUse RunViewToUse Visible

Constructors

constructor

new MjRecordPreviewPopoverComponent(): MjRecordPreviewPopoverComponent
Returns MjRecordPreviewPopoverComponent
Inherited from BaseAngularComponent.constructor

Properties

`Protected`_anchorRect

_anchorRect: RecordPreviewAnchorRect | null = null

`Protected`_destroyed

_destroyed: boolean = false

`Protected`_displayName

_displayName: string | null = null

`Protected`_entityName

_entityName: string | null = null

`Protected`_loadSeq

_loadSeq: number = 0

`Protected`_primaryKey

_primaryKey: CompositeKey | null = null

`Protected`_recordID

_recordID: string | null = null

`Protected`_visible

_visible: boolean = false

AfterQuickEditSaved

AfterQuickEditSaved: EventEmitter<RecordPreviewUpdatedEvent> = ...

Emitted after Quick Edit successfully saves field changes to the target entity.

AllowQuickEdit

AllowQuickEdit: boolean = true

Whether inline quick-edit of summary fields is allowed inside the popover.

BeforeQuickEditSave

BeforeQuickEditSave: EventEmitter<BeforeRecordPreviewSaveEventArgs> = ...

Cancellable event emitted before Quick Edit saves field changes to the target entity.

`Protected`cdr

cdr: ChangeDetectorRef = ...

CopiedID

CopiedID: boolean = false

EditDrafts

EditDrafts: Record<string, string | undefined> = {}

EditErrorMessage

EditErrorMessage: string | null = null

IsEditing

IsEditing: boolean = false

IsLoading

IsLoading: boolean = false

IsSavingEdit

IsSavingEdit: boolean = false

MouseEnterCard

MouseEnterCard: EventEmitter<void> = ...

MouseLeaveCard

MouseLeaveCard: EventEmitter<void> = ...

Navigate

Navigate: EventEmitter<FormNavigationEvent> = ...

Provider

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.

RecordUpdated

RecordUpdated: EventEmitter<RecordPreviewUpdatedEvent> = ...

Emitted after Quick Edit saves field changes (alias/companion to AfterQuickEditSaved).

Summary

Summary: RecordPreviewSummary | null = null

`Protected` `Static` `Readonly`CACHE_MAX_ENTRIES

CACHE_MAX_ENTRIES: 500

`Protected` `Static` `Readonly`CACHE_TTL_MS

CACHE_TTL_MS: 60000 = 60_000

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

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

`Protected` `Static` `Readonly`summaryCache

summaryCache: MJLruCache<
string,
{ LoadedAt: number; Summary: RecordPreviewSummary },
> = ...

Bounded: one entry per previewed record would otherwise accumulate for the whole session.

Accessors

ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

Returns IMetadataProvider
Inherited from BaseAngularComponent.ProviderToUse
- Defined in packages/Angular/Generic/base-types/dist/base-angular-component.d.ts:17

RecordID

get RecordID(): string | null
Returns string | null
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:166
set RecordID(value: string | null): void
Parameters
- value: string | null
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:169

RunQueryToUse

get RunQueryToUse(): IRunQueryProvider
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

Returns IRunQueryProvider
Inherited from BaseAngularComponent.RunQueryToUse
- Defined in packages/Angular/Generic/base-types/dist/base-angular-component.d.ts:25

RunViewToUse

get RunViewToUse(): IRunViewProvider
Returns either the default RunView provider or the one specified in the Provider property, if it was specified

Returns IRunViewProvider
Inherited from BaseAngularComponent.RunViewToUse
- Defined in packages/Angular/Generic/base-types/dist/base-angular-component.d.ts:21

Visible

get Visible(): boolean
Returns boolean
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:211
set Visible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:214

Methods

`Protected`buildSummaryCacheKey

buildSummaryCacheKey(entityName: string, recordKey: string): string
Parameters
- entityName: string
- recordKey: string
Returns string
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:265

`Protected`buildSummaryFromRow

buildSummaryFromRow(
    entityInfo: EntityInfo,
    pk: CompositeKey,
    recordIdStr: string,
    candidateFields: EntityFieldInfo[],
    row: Record<string, unknown> | null,
): RecordPreviewSummary
Parameters
- entityInfo: EntityInfo
- pk: CompositeKey
- recordIdStr: string
- candidateFields: EntityFieldInfo[]
- row: Record<string, unknown> | null
Returns RecordPreviewSummary
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:724

`Protected`coerceDraftValue

coerceDraftValue(draft: string, field?: EntityFieldInfo): unknown
Parameters
- draft: string
- Optionalfield: EntityFieldInfo
Returns unknown
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:496

`Protected`formatPreviewValue

formatPreviewValue(val: unknown, field: EntityFieldInfo): string
Parameters
- val: unknown
- field: EntityFieldInfo
Returns string
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:831

`Protected`isFieldQuickEditable

isFieldQuickEditable(
field: EntityFieldInfo | null | undefined,
canEditEntity: boolean,
): boolean
Parameters
- field: EntityFieldInfo | null | undefined
- canEditEntity: boolean
Returns boolean
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:689

`Protected`isFieldWide

isFieldWide(field: EntityFieldInfo, formattedValue: string): boolean
Determines whether a summary field should span the full 2-column width (grid-column: 1 / -1) so long values like emails, URLs, titles, or addresses never truncate unnecessarily. Subclasses can override this hook to customize column spanning.
Parameters
- field: EntityFieldInfo
- formattedValue: string
Returns boolean
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:679

`Protected`loadSummary

loadSummary(forceRefresh?: boolean): Promise<void>
Parameters
- forceRefresh: boolean = false
Returns Promise<void>
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:562

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:270

OnCancelEdit

OnCancelEdit(event?: MouseEvent): void
Parameters
- Optionalevent: MouseEvent
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:393

OnCardMouseEnter

OnCardMouseEnter(): void
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:354

OnCardMouseLeave

OnCardMouseLeave(): void
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:358

OnCopyRecordID

OnCopyRecordID(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:292

OnEditDraftInput

OnEditDraftInput(fieldName: string, eventOrValue: string | Event): void
Parameters
- fieldName: string
- eventOrValue: string | Event
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:400

OnOpenRecord

OnOpenRecord(openInNewTab: boolean, event: MouseEvent): void
Parameters
- openInNewTab: boolean
- event: MouseEvent
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:531

OnSaveEdit

OnSaveEdit(event?: MouseEvent): Promise<void>
Parameters
- Optionalevent: MouseEvent
Returns Promise<void>
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:412

OnStartEdit

OnStartEdit(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:365

OnTitleAuxClick

OnTitleAuxClick(event: MouseEvent): void
Handles middle-click (auxclick button 1) on the record title link to open in a new tab.
Parameters
- event: MouseEvent
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:525

OnTitleClick

OnTitleClick(event: MouseEvent): void
Handles primary click on the record title link in the Option A header. Supports Ctrl/Cmd/Shift-click to open in a new tab.
Parameters
- event: MouseEvent
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:517

`Protected`resetEditState

resetEditState(): void
Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:278

`Protected`resolveCompositeKey

resolveCompositeKey(entityInfo?: EntityInfo): CompositeKey | null
Parameters
- OptionalentityInfo: EntityInfo
Returns CompositeKey | null
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:551

`Protected`resolveFieldInputType

resolveFieldInputType(
    field: EntityFieldInfo,
): {
    InputType: "number" | "boolean" | "select" | "text";
    PossibleValues?: string[];
}
Parameters
- field: EntityFieldInfo
Returns {
InputType: "number" | "boolean" | "select" | "text";
PossibleValues?: string[];
}
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:704

`Protected`selectPreviewFields

selectPreviewFields(entityInfo: EntityInfo): EntityFieldInfo[]
Parameters
- entityInfo: EntityInfo
Returns EntityFieldInfo[]
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:658

`Static`ClearCache

ClearCache(): void
Clear the static summary cache (useful in unit tests).

Returns void
- Defined in packages/Angular/Generic/base-forms/src/lib/preview-popover/record-preview-popover.component.ts:249

Class MjRecordPreviewPopoverComponent

Pluggable via @RegisterClass and MJGlobal.Instance.ClassFactory

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MjRecordPreviewPopoverComponent

Properties

Protected_anchorRect

Protected_destroyed

Protected_displayName

Protected_entityName

Protected_loadSeq

Protected_primaryKey

Protected_recordID

Protected_visible

AfterQuickEditSaved

AllowQuickEdit

BeforeQuickEditSave

Protectedcdr

CopiedID

EditDrafts

EditErrorMessage

IsEditing

IsLoading

IsSavingEdit

MouseEnterCard

MouseLeaveCard

Navigate

Provider

RecordUpdated

Summary

Protected Static ReadonlyCACHE_MAX_ENTRIES

Protected Static ReadonlyCACHE_TTL_MS

Staticɵdir

Staticɵfac

Protected Static ReadonlysummaryCache

Accessors

AnchorRect

Returns RecordPreviewAnchorRect | null

Parameters

Returns void

CompactRecordID

Returns string

DisplayName

Returns string | null

Parameters

Returns void

EntityName

Returns string | null

Parameters

Returns void

PopoverPositionStyle

Returns Record<string, string>

PrimaryKey

Returns CompositeKey | null

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

RecordID

Returns string | null

Parameters

Returns void

RunQueryToUse

Returns IRunQueryProvider

RunViewToUse

Returns IRunViewProvider

Visible

Returns boolean

Parameters

Returns void

Methods

ProtectedbuildSummaryCacheKey

Parameters

Pluggable via `@RegisterClass` and `MJGlobal.Instance.ClassFactory`

`Protected`_anchorRect

`Protected`_destroyed

`Protected`_displayName

`Protected`_entityName

`Protected`_loadSeq

`Protected`_primaryKey

`Protected`_recordID

`Protected`_visible

`Protected`cdr

`Protected` `Static` `Readonly`CACHE_MAX_ENTRIES

`Protected` `Static` `Readonly`CACHE_TTL_MS

`Static`ɵdir

`Static`ɵfac

`Protected` `Static` `Readonly`summaryCache

`Protected`buildSummaryCacheKey

`Protected`buildSummaryFromRow

`Protected`coerceDraftValue

`Protected`formatPreviewValue

`Protected`isFieldQuickEditable

`Protected`isFieldWide

`Protected`loadSummary

`Protected`resetEditState

`Protected`resolveCompositeKey

`Protected`resolveFieldInputType

Returns {
InputType: "number" | "boolean" | "select" | "text";
PossibleValues?: string[];
}

`Protected`selectPreviewFields

`Static`ClearCache