Select your printer model
addRegisterDownloadImage method
Adds the registration of the image data drawn on the HTML5 Canvas to the command buffer.
The specified image data can be registered in the download graphics area of customer display, and can be called by addDownloadImage method.
Converts the specified range of the RGBA full color image of HTML5 Canvas to image data.
One pixel of the image corresponds to one dot of the customer display, and if a transparent color is included, the background color of the image is assumed to be white.
Syntax
addRegisterDownloadImage(data, key1, key2); |
Parameter
context
Value |
Description |
---|---|
context |
Specifies the 2D context of HTML5 Canvas. |
key1
Value |
Description |
---|---|
Integer value from 48 to 57, 65 to 90, and 97 to 122 |
Specifies keycode 1. |
key2
Value |
Description |
---|---|
Integer value from 48 to 57, 65 to 90, and 97 to 122 |
Specifies keycode 2. |
Return value
Return value |
Object type |
---|---|
Display object |
Display |
Exception
Return value |
Object type |
---|---|
Parameter " ... " is invalid |
Error |
Supplementary explanation
- This API cannot be used simultaneously with other APIs.
After executing this API, do not execute any other API until the callback is returned. - Execute a send method after each execution of this API to register images one by one.
- If success is not returned in onreceive event by the send method execution results after the execution of this API, restart the printer.
Depending on the system environment, it may take some time for the recovery process. - If the power supply to the customer display is cut off, the registered image is erased.
- As the data size of the image to be registered increases, the processing time becomes longer. (Max. 320 seconds)
- If the data size of the image to be registered is large, and the communication environment
is poor, the image may not be registered in this API.
If the image cannot be registered in this API, use a dedicated Utility software.
For details on the dedicated Utility software, refer to the Technical Reference Guide of each customer display. - If an image is registered in the specified keycode, it is overwritten and registered.
- Image data expressed in the pixel format of YCbCr422 or YCbCr420 can be used.
- The image size should be about 100 KB although the upper limit of the image size is 1.5 MB.
- Total size of images that can be registered is 1.5 MB.
This API converts the image format and pixel count so that the customer displays can process the images and then register them. The conversion processing may increase the size of images, so ensure that there is sufficient free space in the download graphics area to accommodate the total size of the images to be registered.
No error is returned when registration was not successful due to insufficient free space in the download graphics area. - Pixel values for width and height of an image should be even numbers.
- When using a transmission image, use data in the png format.
- Please use an image that matches the size of the image area in the customer display.
Using an image larger than the size of the image area will cause the image to be trimmed to fit the size of the image area. - An HTML5 Canvas including images downloaded from different domains cannot be displayed.
A security error occurs as a result of the same-origin policy of JavaScript.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- ePOSDevice object
- Common to device objects
- OtherPeripheral object
- Display object
- createWindow method
- destroyWindow method
- setCurrentWindow method
- clearWindow method
- addCreateScreen method
- addCreateScreenCustom method
- createTextArea method
- destroyTextArea method
- setCurrentTextArea method
- clearTextArea method
- setCursorPosition method
- moveCursorPosition method
- setCursorType method
- addText method
- addReverseText method
- addMarquee method
- setBlink method
- setBrightness method
- addBackgroundColor method
- addStartSlideShow method
- addStopSlideShow method
- addDownloadImage method
- addRegisterDownloadImage method
- addNVImage method
- addClearImage method
- addSymbol method
- addClearSymbol method
- showClock method
- addCommand method
- send method
- reset method
- onreceive event
- Keyboard object
- POSKeyboard object
- MSR object
- Printer object
- addTextAlign method
- addTextLineSpace method
- addTextRotate method
- addText method
- addTextLang method
- addTextFont method
- addTextSmooth method
- addTextDouble method
- addTextSize method
- addTextStyle method
- addTextPosition method
- addTextVPosition method
- addFeedUnit method
- addFeedLine method
- addFeedPosition method
- addFeed method
- addImage method
- addLogo method
- addBarcode method
- addSymbol method
- addHLine method
- addVLineBegin method
- addVLineEnd method
- addPageBegin method
- addPageEnd method
- addPageArea method
- addPageDirection method
- addPagePosition method
- addPageLine method
- addPageRectangle method
- addRotateBegin method
- addRotateEnd method
- addCut method
- addPulse method
- addSound method
- addLayout method
- recover method
- addRecovery method
- reset method
- addReset method
- addCommand method
- send method
- print method
- getPrintJobStatus method
- startMonitor method
- stopMonitor method
- halftone property
- brightness property
- force property
- timeout property
- interval property
- drawerOpenLevel property
- message property
- onreceive event
- onstatuschange event
- onbatterystatuschange event
- ononline event
- onoffline event
- onpoweroff event
- oncoverok event
- oncoveropen event
- onpaperok event
- onpapernearend event
- onpaperend event
- ondrawerclosed event
- ondraweropen event
- onbatteryok event
- onbatterylow event
- HybridPrinter2 object
- lock method
- unlock method
- selectPaperType method
- waitInsertion method
- cancelInsertion method
- ejectPaper method
- sendData method
- print method
- readMicrData method
- cleanMicrReader method
- recover method
- reset method
- startMonitor method
- stopMonitor method
- setMessage method
- getMessage method
- halftone property
- brightness property
- force property
- paperType property
- interval property
- waitTime property
- enable40cplMode property
- onreceive event
- Scanner object
- SimpleSerial object
- GermanyFiscalElement object
- DeviceHubTerminal object
- CommBoxManager object
- CommBox object
- ePosDeviceConfiguration object
- Appendix
- Error Code List
- Key code list
- List of Supported Objects
- List of Supported APIs
- Printer-specific Support Information
- TM-m10
- TM-m30
- TM-m30II
- TM-m30II-H
- TM-m30II-NT
- TM-m30II-S
- TM-m30II-SL
- TM-m30III
- TM-m30III-H
- TM-m50
- TM-m50II
- TM-m50II-H
- TM-T20II
- TM-T20III
- TM-T82III
- TM-T88VI
- TM-T88VII
- TM-L100
- TM-T70
- TM-T70II
- TM-T88IV
- TM-T88V
- TM-U220
- TM-U220II
- TM-U330
- TM-P20
- TM-P20II
- TM-P60II (Receipt)
- TM-P60II (Peeler)
- TM-P80
- TM-P80II
- TM-H6000V
- TM-T20II-i
- TM-T70-i
- TM-T82II-i
- TM-T83II-i
- TM-T88V-i
- TM-T88VI-iHUB
- TM-U220-i
- TM-U220IIB-i
- TM-T70II-DT
- TM-T70II-DT2
- TM-T88V-DT
- TM-T88VI-DT2
- TM-H6000IV-DT
- TM-T20
- TM-T82II
- TM-T83II
- TM-T90
- TM-L90
- TM-H6000IV
- Usage restriction by firmware version