Skip to content

Commit

Permalink
update docs - print options
Browse files Browse the repository at this point in the history
  • Loading branch information
yeasir01 committed Feb 10, 2024
1 parent 1c6ca54 commit a1ffb7a
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 15 deletions.
Binary file added .github/images/auto-cut-chain-print.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/auto-cut-half-chain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/auto-cut-half-cut.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/ncp-cut-mark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/ncp-no-cut.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/special-tape.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,8 @@
"files.eol": "\n",
"[github-actions-workflow]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[markdown]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
60 changes: 49 additions & 11 deletions docs/options.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Notice
Properties are applicable exclusively to models that support each respective function. If a model does not support a particular function, the configuration becomes invalid, even if a prop is specified.

## Supported Ext Types (File Export)
## Supported Ext Types - For Exporting Files
| **Description** | **Extension** |
|---|:---:|
| LBX type | .lbx |
Expand All @@ -10,7 +10,7 @@ Properties are applicable exclusively to models that support each respective fun
| BMP Image | .bmp |
| PAF Type | .paf |

## Print Option Props
## Print Options
| **Key** | **Type** | **Default** | **Description** |
|---|---|:---:|---|
| copies | number | 1 |Number of copies to print.|
Expand All @@ -33,13 +33,51 @@ Properties are applicable exclusively to models that support each respective fun
| fitPage | boolean | false |Specify whether to adjust the size and position of objects in the template in accordance with layout changes resulting from media changes. If set to true, adjustments will be made; otherwise, if set to false or undefined, no adjustments will be applied..|

## PT-9500PC / PT-9600 / PT-3600
| **noCut** | **autoCut** | **halfCut** | **cutMark** | **chainPrint** | **cutAtEnd** | **specialTape** | **Result** |
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|---:|
|✔️|-|-|-|-|-|-|![no cut](../.github/images/no-cut.png) |
|-|-|-|-|✔️|-|-|![chain print](../.github/images/chain-print.png) |
|-|-|✔️|-|-|-|-|![half cut](../.github/images/half-cut.png) |
|-|-|✔️|-|✔️|-|-|![half cut chain](../.github/images/half-cut-chain.png) |
|-|✔️|-|-|-|-|-|![auto cut](../.github/images/auto-cut.png) |
|-|✔️|✔️|-|-|-|-|![auto cut half cut](../.github/images/auto-half-cut.png) |
|-|✔️|✔️|-|✔️|-|-|![auto half chain](../.github/images/auto-half-chain.png) |
| **noCut** | **autoCut** | **halfCut**| **chainPrint** | **Result** |
|:---:|:---:|:---:|:---:|---:|
|✔️|-|-|-|![noCut](../.github/images/no-cut.png) |
|-|-|-|✔️|![chainPrint](../.github/images/chain-print.png) |
|-|-|✔️|-|![halfCut](../.github/images/half-cut.png) |
|-|-|✔️|✔️|![halfCut chainPrint](../.github/images/half-cut-chain.png) |
|-|✔️|-|-|![autoCut](../.github/images/auto-cut.png) |
|-|✔️|-|✔️|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
|-|✔️|✔️|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) |
|-|✔️|✔️|✔️|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) |

## PT-9700PC / PT-9800PCN / PT-P750W / PT-P910BT / PT-E550W
| **noCut** | **autoCut** | **halfCut** | **chainPrint** | **specialTape** | **Result** |
|:---:|:---:|:---:|:---:|:---:|---:|
|✔️|-|-|-|-|![noCut](../.github/images/no-cut.png) |
|-|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) |
|-|-|✔️|-|-|![halfCut](../.github/images/half-cut.png) |
|-|-|✔️|✔️|-|![halfCut chainPrint](../.github/images/half-cut-chain.png) |
|-|✔️|-|-|-|![autoCut](../.github/images/auto-cut.png) |
|-|✔️|-|✔️|-|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
|-|✔️|✔️|-|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) |
|-|✔️|✔️|✔️|-|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) |
|-|-|-|-|✔️|![specialTape](../.github/images/special-tape.png) |

## PT-D450
| **noCut** | **cutMark** | **chainPrint** | **Result** |
|:---:|:---:|:---:|---:|
|✔️|-|-|![noCut](../.github/images/ncp-no-cut.png) |
|-|-|✔️|![chainPrint](../.github/images/chain-print.png) |
|-|✔️|-|![cutMark](../.github/images/ncp-cut-mark.png) |
|-|✔️|✔️|![cutMark chainPrint](../.github/images/half-cut-chain.png) |

## PT-E800T / PT-E800TK / PT-E850TKW
| **Media** | **noCut** | **autoCut** | **halfCut** | **chainPrint** | **specialTape** | **Result** |
|:----------|:---:|:---:|:---:|:---:|:---:|---:|
| TZe |✔️|-|-|-|-|![noCut](../.github/images/no-cut.png) | 1
| TZe |-|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) | 2
| TZe |-|-|✔️|-|-|![halfCut](../.github/images/half-cut.png) | 3
| TZe |-|-|✔️|✔️|-|![halfCut chainPrint](../.github/images/half-cut-chain.png) | 4
| TZe |-|-|-|-|-|![autoCut](../.github/images/auto-cut.png) | 5
| TZe |-|-|-|-|-|![autoCut](../.github/images/auto-cut.png) | 6
| TZe |-|-|-|-|-|![autoCut](../.github/images/auto-cut.png) | 7
| TZe |-|-|-|-|-|![autoCut](../.github/images/auto-cut.png) | 8
| TZe |-|-|-|-|-|![autoCut](../.github/images/auto-cut.png) | 9
| PVC Tube |-|-|-|-|-|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) | 10
| PVC Tube |-|-|-|-|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) | 11
| FLe |-|-|-|-|-|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) | 12
| FLe |-|-|-|-|-|![specialTape](../.github/images/special-tape.png) | 13
8 changes: 4 additions & 4 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ const data = {
date: new Date("2024-1-20"),
};

// Docs >> Options >> Print Config Options - for all options
// Docs >> Options >> Print Options - for all options
const options = {
copies: 1,
printName: "Air Force Label",
Expand Down Expand Up @@ -158,7 +158,7 @@ previewBtn.addEventListener("click", previewImage);
// script.js file
import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@latest/dist/index.mjs";

const expBtn = document.getElementById("export-btn");
const exp = document.getElementById("export-btn");

const tag = new BrotherSdk({
templatePath: "C:/Templates/shoe-template.lbx",
Expand All @@ -175,14 +175,14 @@ const data = {

const exportFile = async () => {
try {
// Docs >> Options >> Supported Export Extensions - for support file types
// Docs >> Options >> Supported Ext Types - for support file types
const success = await tag.export(data, "Air-Force.bmp", 300);
console.log({success}) // Output: {success: true}
} catch (error) {
console.log({error})
}
};

expBtn.addEventListener("click", exportFile);
exp.addEventListener("click", exportFile);

```

0 comments on commit a1ffb7a

Please sign in to comment.