Member Junction
    Preparing search index...

    Class ListDetailGridComponent

    ListDetailGridComponent - Displays records from a List using mj-entity-data-grid

    This component wraps the modern mj-entity-data-grid component to display records that belong to a specific List. It uses a subquery filter to fetch only records whose IDs are in the List Details for the given ListID.

    <mj-list-detail-grid
      [listId]="selectedList.ID"
      [autoNavigate]="true"
      (rowClicked)="onRecordSelected($event)">
    </mj-list-detail-grid>

    Hierarchy (View Summary)

    Implements

    • OnInit
    • OnChanges
    Index

    Constructors

    constructor

    Properties

    autoNavigate dataLoaded entityDataGrid entityInfo gridParams height isLoading listEntity listId listLoaded Provider rowClicked rowDoubleClicked selectedKeys selectionChange selectionMode showToolbar toolbarConfig totalRowCount ɵdir ɵfac

    Accessors

    effectiveToolbarConfig ProviderToUse rowCount RunQueryToUse RunReportToUse RunViewToUse selectedCount

    Methods

    clearSelection export getSelectedRows ngOnChanges ngOnInit onDataLoaded onRowClick onRowDoubleClick onSelectionChange refresh selectAll selectRows

    Constructors

    Properties

    autoNavigate: boolean = true

    Whether to auto-navigate to the record when double-clicked. Defaults to true.

    dataLoaded: EventEmitter<{ totalCount: number }> = ...

    Emitted when the grid data is loaded.

    entityDataGrid: EntityDataGridComponent | undefined
    entityInfo: EntityInfo | null = null
    gridParams: RunViewParams | null = null
    height: number | "auto" | "fit-content" = 'auto'

    Height of the grid. Can be a number (pixels), 'auto', or 'fit-content'. Defaults to 'auto'.

    isLoading: boolean = false
    listEntity: MJListEntity | null = null

    Optional: The List entity object if already loaded. If provided, avoids an extra database call to load the list.

    listId: string | null = null

    The List ID to display records for. When set, the component loads the list entity and builds a filter to show only records that are in this list.

    listLoaded: boolean = false
    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.

    rowClicked: EventEmitter<ListGridRowClickedEvent> = ...

    Emitted when a row is clicked (single click).

    rowDoubleClicked: EventEmitter<ListGridRowClickedEvent> = ...

    Emitted when a row is double-clicked.

    selectedKeys: string[] = []
    selectionChange: EventEmitter<string[]> = ...

    Emitted when row selection changes (for checkbox mode).

    selectionMode: GridSelectionMode = 'single'

    Selection mode for the grid. Defaults to 'single'.

    showToolbar: boolean = true

    Show the grid toolbar. Defaults to true.

    toolbarConfig: GridToolbarConfig | null = null

    Custom toolbar configuration. If not provided, uses default.

    totalRowCount: number = 0
    "ɵdir": unknown
    "ɵfac": unknown

    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 RunReportToUse(): IRunReportProvider

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

      Returns IRunReportProvider

    • get RunViewToUse(): IRunViewProvider

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

      Returns IRunViewProvider

    Methods

    • A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

      Parameters

      • changes: { [propName: string]: SimpleChange<any> }

        The changed properties.

      Returns void

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods