Member Junction
    Preparing search index...

    Class SimpleRecordListComponent

    Base class for all Angular components in the MemberJunction system.

    Hierarchy (View Summary)

    Implements

    • OnInit
    Index

    Constructors

    constructor

    Properties

    AllowCustomAction AllowDelete AllowEdit AllowNew Columns CustomActionClicked CustomActionConfirmed CustomActionDialogInfo CustomActionDialogMessage CustomActionDialogTitle customActionDialogVisible CustomActionIcon CustomActionIconFunction customActionItem CustomActionTooltip CustomActionTooltipFunction deleteRecordDialogVisible deleteRecordItem editOrNewRecord EditSectionName EntityName isLoading Provider RecordCreated RecordEdited recordMode records RecordSelected showEditOrNewRecordForm SortBy ɵdir ɵfac

    Accessors

    ProviderToUse RunQueryToUse RunReportToUse RunViewToUse

    Methods

    closeCustomActionDialog closeDeleteDialog createNewRecord deleteRecord editRecord getCustomActionIcon getCustomActionTooltip getRecordName ngOnInit onEditOrNewRecordFormClosed performCustomAction Refresh selectRecord

    Constructors

    Properties

    AllowCustomAction: boolean = false

    If true, a custom action button will be shown for each record.

    AllowDelete: boolean = true

    If true, the delete button will be shown for each record.

    AllowEdit: boolean = true

    If true, the edit button will be shown for each record.

    AllowNew: boolean = true

    If true, the new button will be shown.

    Columns: string[] = []

    List of columns to display in the grid. If empty and the entity has > 10 columns, those columns marked as DefaultInView=1 will be used, otherwise the first 10 columns will be used.

    CustomActionClicked: EventEmitter<BaseEntity<unknown>> = ...
    CustomActionConfirmed: EventEmitter<BaseEntity<unknown>> = ...
    CustomActionDialogInfo: string = ''

    Optional additional information for the custom action confirmation dialog

    CustomActionDialogMessage: string = 'Are you sure you want to perform this action?'

    Message for the custom action confirmation dialog

    CustomActionDialogTitle: string = 'Confirm Action'

    Title for the custom action confirmation dialog

    customActionDialogVisible: boolean = false
    CustomActionIcon: string = ''

    The CSS class for the custom action button icon (e.g. 'fa-user-lock')

    CustomActionIconFunction: ((record: BaseEntity) => string) | null = null

    A function that returns the appropriate icon based on the record Signature: (record: BaseEntity) => string If provided, overrides CustomActionIcon

    customActionItem: BaseEntity<unknown> | undefined
    CustomActionTooltip: string = ''

    Tooltip text for the custom action button

    CustomActionTooltipFunction: ((record: BaseEntity) => string) | null = null

    A function that returns the appropriate tooltip text based on the record Signature: (record: BaseEntity) => string If provided, overrides CustomActionTooltip

    deleteRecordDialogVisible: boolean = false
    deleteRecordItem: BaseEntity<unknown> | null
    editOrNewRecord: BaseEntity
    EditSectionName: string = 'details'

    If AllowEdit or AllowNew is true, this is the section name to display for editing a new or existing record.

    EntityName: string = ''

    Name of the entity to display records for.

    isLoading: 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.

    RecordCreated: EventEmitter<BaseEntity<unknown>> = ...
    RecordEdited: EventEmitter<BaseEntity<unknown>> = ...
    recordMode: "new" | "edit" = 'new'
    records: BaseEntity<unknown>[] = []
    RecordSelected: EventEmitter<BaseEntity<unknown>> = ...
    showEditOrNewRecordForm: boolean = false
    SortBy: string = ''

    Name of the column to sort by. If empty, no sorting is done.

    "ɵ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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods