Select your printer model
addBackgroundColor method
Adds the specification of the background color to the command buffer.
The background color from the beginning till the end of the row specified in the text area can be changed.
Syntax
addBackgroundColor(row, r, g, b); |
Parameter
row
Value |
Description |
---|---|
Integer value from 1 to 19 |
Changes the background color of the specified row. |
EVEN_ROWS |
Changes the background color of all even rows. |
ODD_ROWS |
Changes the background color of all odd rows. |
ALL_ROWS |
Changes the background color of all rows. |
r
Value |
Description |
---|---|
Integer value from 0 to 255 |
Specifies the red color value of the background color. |
g
Value |
Description |
---|---|
Integer value from 0 to 255 |
Specifies the green color value of the background color. |
b
Value |
Description |
---|---|
Integer value from 0 to 255 |
Specifies the blue color value of the background color. |
Return value
Return value |
Object type |
---|---|
Display object |
Display |
Exception
Return value |
Object type |
---|---|
Parameter " ... " is invalid |
Error |
Supplementary explanation
- The background color can be applied only to the text area.
- Specify the r, g, b parameters in the RGB565 format.
- Specify the setting value in all of the r, g, and b parameters.
- To apply the background color to a plurality of rows, execute this API a plurality of times.
- To individually specify the background color in a plurality of windows, define the
window in setCurrentTextArea method before executing this API.
If the window is defined beforehand, the background color can be specified individually for each window.
By dividing the window at the position where the background color is to be changed, the background color can be changed in the middle of the row.
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