Member Junction
    Preparing search index...

    Class FindRecordComponent

    Base class for all Angular components in the MemberJunction system.

    Hierarchy (View Summary)

    Implements

    • OnInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    ColumnDefs DefaultColDef DisplayFields EntityName GridTheme loading OnRecordSelected Provider records RowSelectionConfig SearchDebounceTime searchHasRun searchTerm ɵdir ɵfac

    Accessors

    ProviderToUse RunQueryToUse RunReportToUse RunViewToUse

    Methods

    doSearch ngOnDestroy ngOnInit onFind onGridReady onSearchTermChange onSelectionChange

    Constructors

    Properties

    ColumnDefs: ColDef<any, any>[] = []
    DefaultColDef: ColDef = ...
    DisplayFields: EntityFieldInfo[] = []

    Optional, list of fields to be displayed in the grid of search results, if not specified, the default fields will be displayed

    EntityName: string = ''

    The name of the entity to show records for.

    GridTheme: Theme = ...
    loading: boolean = false
    OnRecordSelected: EventEmitter<BaseEntity<unknown>> = ...

    When a record is selected, this event is emitted with the selected record

    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.

    records: BaseEntity<unknown>[] = []
    RowSelectionConfig: RowSelectionOptions = ...
    SearchDebounceTime: number = 300

    Optional, the number of milliseconds to wait after the last keypress before triggering a search. Default is 300ms

    searchHasRun: boolean = false
    searchTerm: string = ''
    "ɵ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 performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

      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