{"route":"/en-US-v0.14.1/reference/pdf/attach/","title":"Attach","description":"Documentation for the `attach` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"notes","name":"Notes","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-path","name":"path","children":[]},{"id":"parameters-data","name":"data","children":[]},{"id":"parameters-relationship","name":"relationship","children":[]},{"id":"parameters-mime-type","name":"mime-type","children":[]},{"id":"parameters-description","name":"description","children":[]}]}],"body":{"kind":"func","content":{"path":["pdf"],"name":"attach","title":"Attach","keywords":["embed"],"oneliner":"A file that will be attached to the output PDF.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A file that will be attached to the output PDF.

\n

This can be used to distribute additional files associated with the PDF\nwithin it. PDF readers will display the files in a file listing.

\n

Some international standards use this mechanism to attach machine-readable\ndata (e.g., ZUGFeRD/Factur-X for invoices) that mirrors the visual content\nof the PDF.

\n

Example

\n
#pdf.attach(\n  "experiment.csv",\n  relationship: "supplement",\n  mime-type: "text/csv",\n  description: "Raw Oxygen readings from the Arctic experiment",\n)\n
\n

Notes

\n"}],"self":false,"params":[{"name":"path","details":[{"kind":"html","content":"

The path of the file to be attached.

\n

Must always be specified, but is only read from if no data is provided\nin the following argument.

"}],"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"data","details":[{"kind":"html","content":"

Raw file data, optionally.

\n

If omitted, the data is read from the specified path.

"}],"types":["bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"relationship","details":[{"kind":"html","content":"

The relationship of the attached file to the document.

\n

Ignored if export doesn't target PDF/A-3.

"}],"types":["none","str"],"strings":[{"string":"source","details":"

The PDF document was created from the source file.

"},{"string":"data","details":"

The file was used to derive a visual presentation in the PDF.

"},{"string":"alternative","details":"

An alternative representation of the document.

"},{"string":"supplement","details":"

Additional resources for the document.

"}],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"mime-type","details":[{"kind":"html","content":"

The MIME type of the attached file.

"}],"types":["none","str"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"description","details":[{"kind":"html","content":"

A description for the attached file.

"}],"types":["none","str"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}}}