Member Junction
    Preparing search index...

    Class RecordAttachmentsComponent

    World-class Angular component for displaying, previewing, uploading, and managing file attachments linked to an entity record.

    Selector: mj-record-attachments

    Hierarchy (View Summary)

    Implements

    • OnInit
    • OnChanges
    Index

    Constructors

    constructor

    Properties

    ActiveMenuLinkID ActivePreviewItem ActivePreviewSafeUrl ActivePreviewTextContent ActivePreviewUrl ActiveProviders AfterDelete AfterDownload AfterPreview AfterReplace AfterUnlink AfterUpload AllowDelete AllowDownload AllowEditMetadata AllowPreview AllowReplace AllowUnlink AllowUpload AttachmentCountChanged Attachments BeforeDelete BeforeDownload BeforePreview BeforeReplace BeforeUnlink BeforeUpload Config? EditMetadataDescription EditMetadataItem EditMetadataModalOpen EditMetadataName EntityID? fileInputRef? IsLoading IsLoadingPreview IsMediaLoaded IsUploading MaxWidthRatio MinWidthPx PanelClosed PreviewModalOpen Provider Record? RecordID? replaceInputRef? Resizable SearchTerm SelectedProviderFilter SelectedStorageAccountID ShowProviderFilter ShowSearch StorageAccounts Title UploadingFileName UploadProgressPercent UploadStatusText UserCanCreateFile UserCanCreateLink UserCanDeleteFile UserCanDeleteLink UserCanUpdateFile ViewMode ViewModeChanged Visible WidthChanged WidthPx ɵdir ɵfac

    Accessors

    EffectiveAllowDelete EffectiveAllowUnlink EffectiveAllowUpload EffectiveEntityID EffectiveRecordID FilteredAttachments ProviderCounts ProviderToUse RunQueryToUse RunViewToUse TotalSizeFormatted

    Methods

    CloseEditMetadataModal CloseItemMenu ClosePanel ClosePreviewModal DeleteAttachment DownloadAttachment FormatSize GetFallbackProviderIcon GetFileColorClass GetFileIcon GetMediaType GetProviderBrandColor GetProviderIcon GetProviderItemCount ngOnChanges ngOnInit OnDocumentClick OnDragOver OnDrop OnEscapePress OnFilesSelected OnPreviewMediaLoaded OnReplaceFileSelected OnWidthChanged OpenAttachmentRecord OpenEditMetadata PreviewAttachment Refresh ReplaceAttachment RequestReplace SaveEditMetadata SetViewMode ToggleItemMenu UnlinkAttachment UploadFiles

    Constructors

    Properties

    ActiveMenuLinkID: string | null = null

    Active Overflow Menu

    ActivePreviewItem: RecordAttachmentItem | null = null
    ActivePreviewSafeUrl: SafeResourceUrl | null = null
    ActivePreviewTextContent: string | null = null
    ActivePreviewUrl: string | null = null
    ActiveProviders: MJFileStorageProviderEntity[] = []
    AfterDelete: EventEmitter<AfterDeleteAttachmentEventArgs> = ...
    AfterDownload: EventEmitter<AfterDownloadAttachmentEventArgs> = ...
    AfterPreview: EventEmitter<AfterPreviewAttachmentEventArgs> = ...
    AfterReplace: EventEmitter<AfterReplaceAttachmentEventArgs> = ...
    AfterUnlink: EventEmitter<AfterUnlinkAttachmentEventArgs> = ...
    AfterUpload: EventEmitter<AfterUploadAttachmentEventArgs> = ...
    AllowDelete: boolean = true
    AllowDownload: boolean = true
    AllowEditMetadata: boolean = true
    AllowPreview: boolean = true
    AllowReplace: boolean = true
    AllowUnlink: boolean = true
    AllowUpload: boolean = true

    Permissions / Feature flags

    AttachmentCountChanged: EventEmitter<number> = ...
    Attachments: RecordAttachmentItem[] = []

    Bound attachment items (supports direct data-binding / manipulation)

    BeforeDelete: EventEmitter<BeforeDeleteAttachmentEventArgs> = ...
    BeforeDownload: EventEmitter<BeforeDownloadAttachmentEventArgs> = ...
    BeforePreview: EventEmitter<BeforePreviewAttachmentEventArgs> = ...
    BeforeReplace: EventEmitter<BeforeReplaceAttachmentEventArgs> = ...
    BeforeUnlink: EventEmitter<BeforeUnlinkAttachmentEventArgs> = ...
    BeforeUpload: EventEmitter<BeforeUploadAttachmentEventArgs> = ...
    Config?: RecordAttachmentsConfig

    Attachment configuration bag

    EditMetadataDescription: string = ''
    EditMetadataItem: RecordAttachmentItem | null = null
    EditMetadataModalOpen: boolean = false

    Edit Metadata Dialog

    EditMetadataName: string = ''
    EntityID?: string

    Explicit EntityID (alternative to passing Record)

    fileInputRef?: ElementRef<HTMLInputElement>
    IsLoading: boolean = false
    IsLoadingPreview: boolean = false
    IsMediaLoaded: boolean = false
    IsUploading: boolean = false
    MaxWidthRatio: number = 0.65

    Maximum panel width ratio of viewport

    MinWidthPx: number = 420

    Minimum panel width in px

    PanelClosed: EventEmitter<void> = ...
    PreviewModalOpen: boolean = false

    Active Preview State

    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.

    Record?: BaseEntity<unknown>

    Entity record to load attachments for

    RecordID?: string

    Explicit RecordID (alternative to passing Record)

    replaceInputRef?: ElementRef<HTMLInputElement>
    Resizable: boolean = true

    Whether the slide panel is resizable

    SearchTerm: string = ''
    SelectedProviderFilter: string = 'all'
    SelectedStorageAccountID: string = ''
    ShowProviderFilter: boolean = true

    UI Controls

    ShowSearch: boolean = true
    StorageAccounts: StorageAccountWithProvider[] = []
    Title: string = 'Attachments'

    Panel title

    UploadingFileName: string = ''
    UploadProgressPercent: number = 0
    UploadStatusText: string = ''
    UserCanCreateFile: boolean = true

    User Permissions

    UserCanCreateLink: boolean = true
    UserCanDeleteFile: boolean = true
    UserCanDeleteLink: boolean = true
    UserCanUpdateFile: boolean = true
    ViewMode: AttachmentViewMode = 'grid'
    ViewModeChanged: EventEmitter<AttachmentViewMode> = ...
    Visible: boolean = true

    Whether the slide panel is visible

    WidthChanged: EventEmitter<number> = ...
    WidthPx: number = 0

    Initial width in px. 0 = auto/persisted setting

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

    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 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 Promise<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 Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    ActiveMenuLinkIDActivePreviewItemActivePreviewSafeUrlActivePreviewTextContentActivePreviewUrlActiveProvidersAfterDeleteAfterDownloadAfterPreviewAfterReplaceAfterUnlinkAfterUploadAllowDeleteAllowDownloadAllowEditMetadataAllowPreviewAllowReplaceAllowUnlinkAllowUploadAttachmentCountChangedAttachmentsBeforeDeleteBeforeDownloadBeforePreviewBeforeReplaceBeforeUnlinkBeforeUploadConfigEditMetadataDescriptionEditMetadataItemEditMetadataModalOpenEditMetadataNameEntityIDfileInputRefIsLoadingIsLoadingPreviewIsMediaLoadedIsUploadingMaxWidthRatioMinWidthPxPanelClosedPreviewModalOpenProviderRecordRecordIDreplaceInputRefResizableSearchTermSelectedProviderFilterSelectedStorageAccountIDShowProviderFilterShowSearchStorageAccountsTitleUploadingFileNameUploadProgressPercentUploadStatusTextUserCanCreateFileUserCanCreateLinkUserCanDeleteFileUserCanDeleteLinkUserCanUpdateFileViewModeViewModeChangedVisibleWidthChangedWidthPxɵdirɵfac
    Accessors
    Methods