addCreateScreenCustom method

Adds the setting of the display mode to the command buffer.

This API enables the specification of width and height in the screen configuration of the base window having customer display.

Syntax

	addCreateScreenCustom(mode, column, row);

Parameter

mode

Specifies the screen configuration of base window (text/image).

Value	Installation method	Screen configuration
LANDSCAPE_LAYOUT_MODE_1	Landscape orientation	“Full screen” The text/image is displayed on the entire page. No division.
LANDSCAPE_LAYOUT_MODE_2	Landscape orientation	“Vertical split” Divided equally into left and right portions. Left: Image, Right: Text
LANDSCAPE_LAYOUT_MODE_3	Landscape orientation	“Vertical split” Divided equally into left and right portions. Left: Text, Right: Image
LANDSCAPE_LAYOUT_MODE_4	Landscape orientation	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
LANDSCAPE_LAYOUT_MODE_5	Landscape orientation	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
PORTRAIT_LAYOUT_MODE_1	Portrait orientation	“Full screen” The text/image is displayed on the entire page. No division.
PORTRAIT_LAYOUT_MODE_2	Portrait orientation	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
PORTRAIT_LAYOUT_MODE_3	Portrait orientation	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
PORTRAIT_LAYOUT_MODE_4	Portrait orientation	“Horizontal split 1:2” Divided into top and bottom portions in the ratio of 1:2. Top: Text, Bottom: Image
PORTRAIT_LAYOUT_MODE_5	Portrait orientation	“Horizontal split 2:1” Divided into top and bottom portions in the ratio of 2:1. Top: Image, Bottom: Text
PORTRAIT_LAYOUT_MODE_6	Portrait orientation	“Horizontal split 2:1” Divided into top and bottom portions in the ratio of 2:1. Top: Text, Bottom: Image
PORTRAIT_LAYOUT_MODE_7	Portrait orientation	“Horizontal split 1:2” Divided into top and bottom portions in the ratio of 1:2. Top: Image, Bottom: Text

column

Specifies the width (number of columns) of the base window display area.

Value	Description
Integer value from 1 to 44	Effective specification range during landscape orientation
Integer value from 1 to 22	Effective specification range during portrait orientation

row

Specifies the height (number of rows) of the base window display area.

Value	Description
Integer value from 1 to 13	Effective specification range during landscape orientation
Integer value from 1 to 19	Effective specification range during portrait orientation

Return value

Return value	Object type
Display object	Display

Exception

Return value	Object type
Parameter " ... " is invalid	Error

Supplementary explanation

If this API is executed, all items displayed in customer display are erased.
An exception occurs if 14 to 19 is specified in row when LANDSCAPE_LAYOUT_MODE is specified in mode.
An exception occurs if 23 to 44 is specified in column when PORTRAIT_LAYOUT_MODE is specified in mode.
Ignored when 45 or more is specified in column and 20 or more is specified in row.

Quick Access

[Name]
[Format]
[Range]
[Description]
[Notes]

Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.

Epson ePOS SDK for JavaScript

Introduction
help
ePOSDevice object
Common to device objects
- callEvent method
OtherPeripheral object
- send method
- onreceive event
Display object
Keyboard object
POSKeyboard object
- onkeypress event
MSR object
- ondata event
Printer object
HybridPrinter2 object
Scanner object
- ondata event
SimpleSerial object
- sendCommand
- oncommandreply event
GermanyFiscalElement object
- operate method
- ongfereceive event
DeviceHubTerminal object
- shutdown method
- restart method
CommBoxManager object
- openCommBox method
- closeCommBox method
CommBox object
ePosDeviceConfiguration object
- Constructor
- getRegisterdDevices method
Appendix
- Error Code List
  - Error Codes acquired in the Callback Parameter and Counteractions
  - Error Codes acquired in the Onreceive Event and Countermeasure
- 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