Class B21L2BPrintTask

Hierarchy (View Summary)

AbstractPrintTask
- B21L2BPrintTask

Index

Constructors

Properties

pagesPrinted printOptions protocol

Methods

emitPrintEndEvent emitProgressEvent isSupportColor makePacketProgressCallback printEnd printheadPixels printInit printPage reset setPrintOptions validatePage waitForFinished waitForPageFinished

Constructors

constructor

new B21L2BPrintTask(
protocol: NiimbotProtocol,
printOptions?: Partial<PrintOptions>,
): B21L2BPrintTask
Parameters
- protocol: NiimbotProtocol
- OptionalprintOptions: Partial<PrintOptions>
Returns B21L2BPrintTask
Inherited from AbstractPrintTask.constructor
- Defined in src/print_tasks/AbstractPrintTask.ts:97

Properties

`Protected`pagesPrinted

pagesPrinted: number

`Protected`printOptions

printOptions: PrintOptions

`Protected`protocol

protocol: NiimbotProtocol

Methods

`Protected`emitPrintEndEvent

emitPrintEndEvent(): void
Returns void
Inherited from AbstractPrintTask.emitPrintEndEvent
- Defined in src/print_tasks/AbstractPrintTask.ts:190

`Protected`emitProgressEvent

emitProgressEvent(pagePrintProgress?: number, pageFeedProgress?: number): void
Parameters
- pagePrintProgress: number = 100
- pageFeedProgress: number = 100
Returns void
Inherited from AbstractPrintTask.emitProgressEvent
- Defined in src/print_tasks/AbstractPrintTask.ts:181

isSupportColor

isSupportColor(pageColor: PageColorType): boolean
Check if this print task supports a specified page color
Parameters
- pageColor: PageColorType
Returns boolean
Inherited from AbstractPrintTask.isSupportColor
- Defined in src/print_tasks/AbstractPrintTask.ts:163

`Protected`makePacketProgressCallback

makePacketProgressCallback(
stepPercent?: number,
): (current: number, total: number) => void
Parameters
- stepPercent: number = 5
Returns (current: number, total: number) => void
Inherited from AbstractPrintTask.makePacketProgressCallback
- Defined in src/print_tasks/AbstractPrintTask.ts:167

printEnd

printEnd(): Promise<boolean>
End print, cleanup

Returns Promise<boolean>
Inherited from AbstractPrintTask.printEnd
- Defined in src/print_tasks/AbstractPrintTask.ts:157

`Protected`printheadPixels

printheadPixels(): number | undefined
Printer's printhead resolution in pixels

Returns number | undefined
Inherited from AbstractPrintTask.printheadPixels
- Defined in src/print_tasks/AbstractPrintTask.ts:153

printInit

printInit(): Promise<void>
Prepare print (set label type, density, print start, ...)

Returns Promise<void>
Overrides AbstractPrintTask.printInit
- Defined in src/print_tasks/B21L2BPrintTask.ts:9

printPage

printPage(image: EncodedImage, quantity?: number): Promise<void>
Print image with a specified number of copies
Parameters
- image: EncodedImage
- Optionalquantity: number
Returns Promise<void>
Overrides AbstractPrintTask.printPage
- Defined in src/print_tasks/B21L2BPrintTask.ts:17

reset

reset(): void
Reset print task state (pages printed)

Returns void
Inherited from AbstractPrintTask.reset
- Defined in src/print_tasks/AbstractPrintTask.ts:115

setPrintOptions

setPrintOptions(printOptions: Partial<PrintOptions>): void
Update print options for this print task
Parameters
- printOptions: Partial<PrintOptions>
Returns void
Inherited from AbstractPrintTask.setPrintOptions
- Defined in src/print_tasks/AbstractPrintTask.ts:108

`Protected`validatePage

validatePage(image: EncodedImage, quantity: number): void
Validate page before printing. Checks:
- Page color is supported by this print task
- Page color matches print task color
- Added pages not does not exceed pagesPrinted
Also increments pagesPrinted by quantity.
Parameters
- image: EncodedImage
- quantity: number
Returns void
Inherited from AbstractPrintTask.validatePage
- Defined in src/print_tasks/AbstractPrintTask.ts:126

waitForFinished

waitForFinished(): Promise<void>
Wait for all print is finished

Returns Promise<void>
Overrides AbstractPrintTask.waitForFinished
- Defined in src/print_tasks/B21L2BPrintTask.ts:44

waitForPageFinished

waitForPageFinished(): Promise<void>
Wait for page print is finished

Returns Promise<void>
Overrides AbstractPrintTask.waitForPageFinished
- Defined in src/print_tasks/B21L2BPrintTask.ts:39