inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/core/services/thumbnail.service.md
Eugenio Romano 00dfd7c5d9
Update doc (#8085)
2023-01-02 14:00:01 +00:00

4.2 KiB
Raw Blame History

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Thumbnail service v2.0.0 Active 2019-03-20

Thumbnail service

Retrieves an SVG thumbnail image to represent a document type.

Class members

Methods

  • getDefaultMimeTypeIcon(): string
    Gets a "miscellaneous" thumbnail URL for types with no other icon defined.
    • Returns string - URL string
  • getDocumentThumbnailUrl(node: NodeEntry|string, attachment?: boolean, ticket?: string): string
    Gets a thumbnail URL for the given document node.
    • node: NodeEntry|string - Node or Node ID to get URL for.
    • attachment: boolean - (Optional) Toggles whether to retrieve content as an attachment for download
    • ticket: string - (Optional) Custom ticket to use for authentication
    • Returns string - URL string
  • getMimeTypeIcon(mimeType: string): string
    Gets a thumbnail URL for a MIME type.
    • mimeType: string - MIME type for the thumbnail
    • Returns string - URL string

Details

The service can locate a thumbnail icon (in SVG format) for either a document node or a MIME type. The default mapping between types and icons is shown in the table below:

Document Icon Types
Compressed archive Archive thumbnail 'application/x-compressed', 'application/x-zip-compressed', 'application/zip'
Text Text thumbnail 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages'
Bitmap/raster image Bitmap thumbnail 'image/png', 'image/jpeg', 'image/gif'
MP4 video MP4 thumbnail 'video/mp4'
SVG vector image SVG thumbnail 'image/svg+xml'
HTML file HTML thumbnail 'text/html'
PDF file PDF thumbnail 'application/pdf'
Folder Folder thumbnail
Disabled folder Disabled folder thumbnail
Excel spreadsheet Spreadsheet thumbnail 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template'
PowerPoint slideshow PowerPoint thumbnail 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.presentationml.template', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow'
Word document Word thumbnail 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template'
Keynote presentation Keynote thumbnail 'application/vnd.apple.keynote'
Numbers spreadsheet Numbers thumbnail 'application/vnd.apple.numbers'

Mat-icon

All the ADF icons for MIME types are now registered into the MatIconRegistry, so you can use all the icons via the <mat-icon> tag:

import { ThumbnailService } from '@alfresco/adf-core';

constructor(public thumbnailService: ThumbnailService) {
}‍‍‍‍‍‍‍‍

MP4 <mat-icon svgIcon="video/mp4"></mat-icon>
PDF <mat-icon svgIcon="application/pdf"></mat-icon>
GIF <mat-icon svgIcon="image/gif"></mat-icon>
.....

See also