Member Junction
    Preparing search index...

    Class JoinGridComponent

    Base class for all Angular components in the MemberJunction system.

    Hierarchy (View Summary)

    Implements

    • AfterViewInit
    Index

    Constructors

    constructor

    Properties

    _columnsEntityData _columnsEntityInfo _GridData _IsLoading _joinEntityData _pendingDeletes _pendingInserts _rowsEntityData _rowsEntityInfo CheckBoxValueField CheckBoxValueMode ColumnsEntityArray? ColumnsEntityDataSource ColumnsEntityDisplayField ColumnsEntityName ColumnsEntityViewName? ColumnsExtraFilter? ColumnsMode ColumnsOrderBy? EditMode JoinEntityColumnForeignKey JoinEntityDisplayColumns? JoinEntityExtraFilter? JoinEntityName JoinEntityRowForeignKey NewRecordDefaultValues? Provider RowsEntityArray? RowsEntityDataSource RowsEntityDisplayField RowsEntityDisplayName? RowsEntityName RowsEntityViewName? RowsExtraFilter? RowsOrderBy? ShowCancelButton ShowSaveButton ɵdir ɵfac

    Accessors

    EntityFieldTSType NumDirtyRecords ProviderToUse RowsEntityDisplayNameOrName RunQueryToUse RunReportToUse RunViewToUse

    Methods

    _FlipRecord _IsColumnChecked AddJoinEntityRecord CancelEdit EditingComplete GetJoinEntityField GetJoinEntityFieldValues IsCellReallyDirty IsRecordReallyDirty ngAfterViewInit OnDropdownValueChange PopulateGridData PopulateRowsAndColsData Refresh RemoveJoinEntityRecord RevertPendingChanges RunColumnsOrRowsView Save UpdateCellValue UpdateCellValueDirect

    Constructors

    Properties

    Protected_columnsEntityData

    _columnsEntityData: BaseEntity<unknown>[] | undefined = undefined

    Protected_columnsEntityInfo

    _columnsEntityInfo: EntityInfo | null = null

    _GridData

    _GridData: JoinGridRow[] = []

    _IsLoading

    _IsLoading: boolean = false

    Protected_joinEntityData

    _joinEntityData: BaseEntity<unknown>[] | undefined = undefined

    Protected_pendingDeletes

    _pendingDeletes: BaseEntity<unknown>[] = []

    Protected_pendingInserts

    _pendingInserts: BaseEntity<unknown>[] = []

    Protected_rowsEntityData

    _rowsEntityData: BaseEntity<unknown>[] | undefined = undefined

    Protected_rowsEntityInfo

    _rowsEntityInfo: EntityInfo | null = null
    CheckBoxValueField: string

    Required when CheckBoxValueMode is set to ColumnValue: the name of the field in the JoinEntity that will be used to store the value of the checkbox.

    CheckBoxValueMode: "RecordExists" | "ColumnValue" = 'RecordExists'

    ONLY USED WHEN ColumnsMode=Entity When this property is set to JoinRecordExists the grid will operate as follows:

    • When a user checks the checkbox in the grid, a record will be created in the JoinEntity with the Row and Column foreign keys.
    • When a user unchecks the checkbox in the grid, the record in the JoinEntity will be deleted. In comparison, when the CheckBoxValueMode is set to ColumnValue, the grid will operate as follows:
    • When a user checks the checkbox in the grid, a value in the JoinEntity will be set to true in the CheckBoxValueField field.
    • When a user unchecks the checkbox in the grid, the value in the JoinEntity will be set to false in the CheckBoxValueField field.
    ColumnsEntityArray?: BaseEntity<unknown>[]

    Required when ColumnsMode is set to Entity: provide an array of BaseEntity objects that will be used to display the columns in the grid.

    ColumnsEntityDataSource: "FullEntity" | "ViewName" | "Array" = 'FullEntity'

    Determines how the column data will be fetched.

    • When set to FullEntity, all columns in the specified ColumnsEntityName will be used.
    • When set to ViewName, the ColumnsEntityViewName will be used to fetch the columns from a defined User View
    • When set to Array, the ColumnsEntityArray array will be used to fetch the columns
    ColumnsEntityDisplayField: string

    Required when ColumnsMode is set to Entity: the field name in the ColumnsEntityName that will be shown as columns in the grid

    ColumnsEntityName: string

    Required when ColumnsMode is set to Entity: the name of the entity that will be used for displaying data for columns. This means that each row in the ColumnsEntity will be shown as a column in the grid

    ColumnsEntityViewName?: string

    Used when ColumnsEntityDataSource = ViewName, this will be the name of the User View for the specified ColumnsEntity to run to get data

    ColumnsExtraFilter?: string

    For ColumnsEntityDataSource = FullEntity or ViewName, this is the extra filter to apply to the columns entity when fetching data. This is optional.

    ColumnsMode: "Entity" | "Fields" = 'Entity'

    When set to Entity, the ColumnsEntity and related settings will be used to build the columns in the grid. When set to Fields, fields from the JoinEntity will be used to build the columns in the grid.

    ColumnsOrderBy?: string

    For ColumnsEntityDataSource = FullEntity or ViewName, this is the order by clause to apply to the columns entity when fetching data. This is optional.

    EditMode: "None" | "Save" | "Queue" = 'None'

    Change the value of this property to true or false when you want to enter or exit edit mode. Only use this when the grid is embedded in another form and you are not showing the built-in save/cancel buttons

    JoinEntityColumnForeignKey: string

    The name of the foreign key field in the JoinEntity that will be used to link to the Primary Key field in the ColumnsEntity

    JoinEntityDisplayColumns?: string[]

    The names of the columns from the JoinEntity to display as columns in the grid. This is only used when ColumnsMode is set to Fields.

    JoinEntityExtraFilter?: string

    When specified, this filter is used to further constrain the data in the JoinEntity. This is optional but is generally most useful when ColumnsMode is set to Fields and you want to filter the data in the JoinEntity based on some criteria.

    JoinEntityName: string

    The name of the entity that will be used for joining the RowsEntity and ColumnsEntity. Or, in the case of ColumnsMode = Fields, there is no true "joining" happening but we are joining the data from the RowsEntity and JoinEntity together.

    JoinEntityRowForeignKey: string

    The name of the foreign key field in the JoinEntity that will be used to link to the Primary Key field in the RowsEntity

    NewRecordDefaultValues?: { [key: string]: any }

    When the CheckBoxValueMode is set to RecordExists this means the grid will be adding and removing records from the JoinEntity. In some cases, entities require additional values beyond the foreign keys that are automatically set, in those cases, use this property to provide additional default values for the new records that are created.

    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.

    RowsEntityArray?: BaseEntity<unknown>[]

    Required: provide an array of BaseEntity objects that will be used to display the rows in the grid.

    RowsEntityDataSource: "FullEntity" | "ViewName" | "Array" = 'FullEntity'

    Determines how the row data will be fetched.

    • When set to FullEntity, all rows in the specified RowEntityName will be used.
    • When set to ViewName, the RowsEntityViewName will be used to fetch the rows from a defined User View
    • When set to Array, the RowsEntityData array will be used to fetch the rows
    RowsEntityDisplayField: string

    Required: the field name in the RowsEntityName that will be shown in the first column in the grid

    RowsEntityDisplayName?: string

    Optional: if provided, this value will be shown in the top-left corner of the grid instead of the RowsEntityName

    RowsEntityName: string

    Required: the name of the entity that will be used for displaying data for rows. This means that each row in the RowsEntity will be shown as a row in the grid where the RowsEntityDisplayField will be used in the first column of the grid.

    RowsEntityViewName?: string

    Used when RowsEntityDataSource = ViewName, this will be the name of the User View for the specified RowsEntity to run to get data

    RowsExtraFilter?: string

    For RowsEntityDataSource = FullEntity or ViewName, this is the extra filter to apply to the rows entity when fetching data. This is optional.

    RowsOrderBy?: string

    For RowsEntityDataSource = FullEntity or ViewName, this is the order by clause to apply to the rows entity when fetching data. This is optional.

    ShowCancelButton: boolean = true

    When set to true, the Cancel button is shown

    ShowSaveButton: boolean = true

    When set to true, the Save button is shown

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

    _FlipRecord

    _IsColumnChecked

    • Parameters

      • dataSource: "FullEntity" | "ViewName"
      • entityName: string
      • OptionalviewName: string
      • OptionalextraFilter: string
      • OptionalorderBy: string

      Returns Promise<BaseEntity<unknown>[]>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods