Class SearchScopeChildGridComponent

Base class for all Angular components in the MemberJunction system.

Hierarchy (View Summary)

BaseAngularComponent
- SearchScopeChildGridComponent

Implements

OnDestroy

Index

Constructors

constructor

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

Properties

AddButtonLabel

AddButtonLabel: string = '+ Add row'

Button label for the "add new row" action.

ChildEntityName

ChildEntityName: string = ''

MJ entity name of the child table (e.g. MJ: Search Scope Providers).

Columns

Columns: SearchScopeChildGridColumn[] = []

Column config — drives rendering of each row.

Disabled

Disabled: boolean = false

Disable all editing (read-only mode).

EmptyMessage

EmptyMessage: string = 'No rows yet.'

Empty-state copy when the grid has zero rows.

IsLoading

IsLoading: boolean = false

LoadError

LoadError: string | null = null

OrderBy

OrderBy: string = ''

Optional OrderBy clause applied to the initial load.

ParentFieldName

ParentFieldName: string = 'SearchScopeID'

FK column on the child that references the parent SearchScope.

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.

RowAdded

RowAdded: EventEmitter<BaseEntity<unknown>> = ...

Emitted after a row is added.

RowRemoved

RowRemoved: EventEmitter<BaseEntity<unknown>> = ...

Emitted after a row is removed.

Rows

Rows: GridRow[] = []

RowsChanged

RowsChanged: EventEmitter<void> = ...

Emitted whenever a row is successfully added or removed.

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

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

Accessors

ParentID

get ParentID(): string | null
Returns string | null
- Defined in search/src/lib/search-scope-child-grid.component.ts:128
set ParentID(value: string | null): void
The parent record ID to filter / attach rows to. For a MJ: Search Scopes parent this is the scope ID; for an MJ: AI Agents parent (assigning scopes to an agent) this is the agent ID. Paired with ParentFieldName which names the FK column.
Parameters
- value: string | null
Returns void
- Defined in search/src/lib/search-scope-child-grid.component.ts:119

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 base-types/dist/base-angular-component.d.ts:17

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 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 base-types/dist/base-angular-component.d.ts:21

Methods

AddRow

AddRow(): Promise<void>
Add a new empty row attached to the current scope.

Returns Promise<void>
- Defined in search/src/lib/search-scope-child-grid.component.ts:220

GetCellValue

GetCellValue(row: GridRow, column: SearchScopeChildGridColumn): unknown
Read a cell value from a row (used by the template).
Parameters
- row: GridRow
- column: SearchScopeChildGridColumn
Returns unknown
- Defined in search/src/lib/search-scope-child-grid.component.ts:284

GetLookupLabel

GetLookupLabel(row: GridRow, column: SearchScopeChildGridColumn): string
Return the display label for a lookup cell.
Parameters
- row: GridRow
- column: SearchScopeChildGridColumn
Returns string
- Defined in search/src/lib/search-scope-child-grid.component.ts:308

GetLookupOptions

GetLookupOptions(
column: SearchScopeChildGridColumn,
): { ID: string; Label: string }[]
Return the dropdown options for a lookup column.
Parameters
- column: SearchScopeChildGridColumn
Returns { ID: string; Label: string }[]
- Defined in search/src/lib/search-scope-child-grid.component.ts:313

LoadRows

LoadRows(): Promise<void>
Reload the grid from the server.

Returns Promise<void>
- Defined in search/src/lib/search-scope-child-grid.component.ts:180

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 search/src/lib/search-scope-child-grid.component.ts:173

RemoveRow

RemoveRow(row: GridRow): Promise<void>
Remove a row (deletes from DB if saved, drops from state if new).
Parameters
- row: GridRow
Returns Promise<void>
- Defined in search/src/lib/search-scope-child-grid.component.ts:262

SaveRow

SaveRow(row: GridRow): Promise<boolean>
Persist changes to a row. Returns true on success.
Parameters
- row: GridRow
Returns Promise<boolean>
- Defined in search/src/lib/search-scope-child-grid.component.ts:239

SetCellValue

SetCellValue(
    row: GridRow,
    column: SearchScopeChildGridColumn,
    value: unknown,
): Promise<void>
Write a cell value back to the row and persist. Lookup columns store the ID but we also refresh the cached display label so the UI stays in sync without a reload.
Parameters
- row: GridRow
- column: SearchScopeChildGridColumn
- value: unknown
Returns Promise<void>
- Defined in search/src/lib/search-scope-child-grid.component.ts:292

Class SearchScopeChildGridComponent

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SearchScopeChildGridComponent

Properties

AddButtonLabel

ChildEntityName

Columns

Disabled

EmptyMessage

IsLoading

LoadError

OrderBy

ParentFieldName

Provider

RowAdded

RowRemoved

Rows

RowsChanged

Staticɵdir

Staticɵfac

Accessors

ParentID

Returns string | null

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

RunQueryToUse

Returns IRunQueryProvider

RunViewToUse

Returns IRunViewProvider

Methods

AddRow

Returns Promise<void>

GetCellValue

Parameters

Returns unknown

GetLookupLabel

Parameters

Returns string

GetLookupOptions

Parameters

Returns { ID: string; Label: string }[]

LoadRows

Returns Promise<void>

ngOnDestroy

Returns void

RemoveRow

Parameters

Returns Promise<void>

SaveRow

Parameters

Returns Promise<boolean>

SetCellValue

Parameters

Returns Promise<void>

Settings

On This Page

`Static`ɵdir

`Static`ɵfac