inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-09-13 22:21:33 +00:00
Code Activity

Plugin external dir (#322)

Browse Source 
* Additional information on plugin configuration options

* Better information on plugin installation

* Update label printing docs

* Rearrange plugin menu

* More menu tweaks

* Fix links to app images
This commit is contained in:
Oliver
2022-07-23 22:40:05 +10:00
committed by GitHub
parent 2e99477478
commit 3def121be2
6 changed files with 81 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/extend/plugins/label.md
View File

@@ -38,18 +38,29 @@ class MyLabelPrinter(LabelPrintingMixin, InvenTreePlugin):
SLUG = "mylabel"
TITLE = "A dummy printer"
def print_label(self, label, **kwargs):
def print_label(self, **kwargs):
"""
Send the label to the printer
Arguments:
label: A PIL (pillow) Image file
kwargs:
pdf_data: An in-memory PDF file of the label
png_file: An in-memory PIL (pillow) Image file of the label
filename: The filename of the printed label (if applicable)
label_instance: The Label model instance
width: width of the label (in mm)
height: height of the label (in mm)
user: The user who printed this label
"""
width = kwargs['width']
height = kwargs['height']
printer_backend.print(label, w=width, h=height)
# This dummy printer supports printing of raw image files
printer_backend.print(png_file, w=width, h=height)
```
### Available Data
The *label* data are supplied to the plugin in both `PDF` and `PNG` formats. This provides compatibility with a great range of label printers "out of the box". Conversion to other formats, if required, is left as an exercise for the plugin developer.
Other arguments provided to the `print_label` function are documented in the code sample above.