.. include:: /Includes.rst.txt .. _fluidtypo3-vhs-media-pdfthumbnail: ================== media.pdfThumbnail ================== Converts the provided PDF file into a PNG thumbnail and renders the according image tag using Fluid's standard image ViewHelper thus implementing its arguments. For PDF documents with multiple pages the first page is rendered by default unless specified. Arguments ========= .. _media.pdfthumbnail_additionalattributes: additionalAttributes -------------------- :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` Additional tag attributes. They will be added directly to the resulting HTML tag. .. _media.pdfthumbnail_data: data ---- :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` Additional data-* attributes. They will each be added with a "data-" prefix. .. _media.pdfthumbnail_aria: aria ---- :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` Additional aria-* attributes. They will each be added with a "aria-" prefix. .. _media.pdfthumbnail_src: src --- :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` Path to the media resource(s). Can contain single or multiple paths for videos/audio (either CSV, array or implementing Traversable). .. _media.pdfthumbnail_relative: relative -------- :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If FALSE media URIs are rendered absolute. URIs in backend mode are always absolute. .. _media.pdfthumbnail_width: width ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. .. _media.pdfthumbnail_height: height ------ :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. .. _media.pdfthumbnail_maxw: maxW ---- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Maximum Width of the image. (no upscaling) .. _media.pdfthumbnail_maxh: maxH ---- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Maximum Height of the image. (no upscaling) .. _media.pdfthumbnail_minw: minW ---- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Minimum Width of the image. .. _media.pdfthumbnail_minh: minH ---- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Minimum Height of the image. .. _media.pdfthumbnail_format: format ------ :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Format of the processed file - also determines the target file format. If blank, TYPO3/IM/GM default is taken into account. .. _media.pdfthumbnail_quality: quality ------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Quality of the processed image. If blank/not present falls back to the default quality defined in install tool. .. _media.pdfthumbnail_treatidasreference: treatIdAsReference ------------------ :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` When TRUE treat given src argument as sys_file_reference record. Applies only to TYPO3 6.x and above. .. _media.pdfthumbnail_canvaswidth: canvasWidth ----------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Width of an optional canvas to place the image on. .. _media.pdfthumbnail_canvasheight: canvasHeight ------------ :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Height of an optional canvas to place the image on. .. _media.pdfthumbnail_canvascolor: canvasColor ----------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Background color of an optional canvas to place the image on (hex triplet). .. _media.pdfthumbnail_transparencycolor: transparencyColor ----------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Color to set transparent when using canvas feature (hex triplet). .. _media.pdfthumbnail_crop: crop ---- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Information generated by the backend's graphical cropping UI .. _media.pdfthumbnail_class: class ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` CSS class(es) for this element .. _media.pdfthumbnail_dir: dir --- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) .. _media.pdfthumbnail_id: id -- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Unique (in this file) identifier for this HTML element. .. _media.pdfthumbnail_lang: lang ---- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Language for this element. Use short names specified in RFC 1766 .. _media.pdfthumbnail_style: style ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Individual CSS styles for this element .. _media.pdfthumbnail_title: title ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Tooltip text of element .. _media.pdfthumbnail_accesskey: accesskey --------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Keyboard shortcut to access this element .. _media.pdfthumbnail_tabindex: tabindex -------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Specifies the tab order of this element .. _media.pdfthumbnail_onclick: onclick ------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` JavaScript evaluated for the onclick event .. _media.pdfthumbnail_usemap: usemap ------ :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` A hash-name reference to a map element with which to associate the image. .. _media.pdfthumbnail_ismap: ismap ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Specifies that its img element provides access to a server-side image map. .. _media.pdfthumbnail_alt: alt --- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Equivalent content for those who cannot process images or who have image loading disabled. .. _media.pdfthumbnail_srcset: srcset ------ :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` List of width used for the srcset variants (either CSV, array or implementing Traversable) .. _media.pdfthumbnail_srcsetdefault: srcsetDefault ------------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Default width to use as a fallback for browsers that don't support srcset .. _media.pdfthumbnail_path: path ---- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` DEPRECATED: Use src instead .. _media.pdfthumbnail_minwidth: minWidth -------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` DEPRECATED: Use minW instead .. _media.pdfthumbnail_minheight: minHeight --------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` DEPRECATED: Use minH instead .. _media.pdfthumbnail_maxwidth: maxWidth -------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` DEPRECATED: Use maxW instead .. _media.pdfthumbnail_maxheight: maxHeight --------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` DEPRECATED: Use maxH instead .. _media.pdfthumbnail_density: density ------- :aspect:`DataType` integer :aspect:`Default` 100 :aspect:`Required` false :aspect:`Description` Canvas resolution for rendering the PDF in dpi (higher means better quality) .. _media.pdfthumbnail_background: background ---------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Fill background of resulting image with this color (for transparent source files) .. _media.pdfthumbnail_rotate: rotate ------ :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Number of degress to rotate resulting image by (caution: very slow if not multiple of 90) .. _media.pdfthumbnail_page: page ---- :aspect:`DataType` integer :aspect:`Default` 1 :aspect:`Required` false :aspect:`Description` Optional page number to render as thumbnail for PDF documents with multiple pages .. _media.pdfthumbnail_forceoverwrite: forceOverwrite -------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` Forcibly overwrite existing converted PDF files