Select your printer model

Parameters are refined by the selected printer.

addSymbol method


Adds the display of the two-dimensional symbol to the command buffer.

Syntax

 
addSymbol(data, type, level, width, height, dotX, dotY, quietZone);

Parameter

data

Specifies the two-dimensional symbol data as a string.

Specify a string in accordance with the standard of the two-dimensional symbol specified in type.

Type

Description

QR Code Model 1

After converting the string to shift JIS, perform the escape sequence processing, select the data type from the following, and perform encoding.

  • Numbers: 0 to 9
  • Alphanumeric characters: 0 to 9, A to Z, space, $, %, *, +, -, ., /, :
  • Kanji characters: Kanji characters that can be expressed in shift JIS
  • 8-bit byte data: 0x00 to 0xff

QR Code Model 2

When specifying binary data that cannot be expressed as a string, specify in the following escape sequence.

String

Description

\xnn

Control code (nn is specified in hexadecimals)

\\

Backslash

type

Value

Description

SYMBOL_QRCODE_MODEL_1

Specifies QR Code Model 1

SYMBOL_QRCODE_MODEL_2

Specifies QR Code Model 2

level

Value

Description

LEVEL_L

Specifies error revision level L.

LEVEL_M

Specifies error revision level M.

LEVEL_Q

Specifies error revision level Q.

LEVEL_H

Specifies error revision level H.

LEVEL_DEFAULT(LEVEL_M)

Specifies the default value (error revision level M).

width

Value

Description

Integer value from 1 to 255

Specifies the module width (in dots).

Effective specification range of QR Code

Integer value from 3 to 16 (default value: 3)

height

Value

Description

Integer value from 1 to 255

Specifies the module height (in dots).

No effective specification range of QR Code.

Since the QR Code is square, the specification of the height is ignored.

dotX

Specifies the origin of the x-coordinate for displaying the two-dimensional symbol (in dots).

Value

Description

Integer value from 0 to 799

Effective specification range during landscape orientation

Integer value from 0 to 479

Effective specification range during portrait orientation

dotY

Specifies the origin of the y-coordinate for displaying the two-dimensional symbol (in dots).

Value

Description

Integer value from 0 to 479

Effective specification range during landscape orientation

Integer value from 0 to 799

Effective specification range during portrait orientation

quietZone

Value

Description

true

Specifies quiet zone assignment as enabled.

false

Specifies quiet zone assignment as disabled.

Return value

Return value

Object type

Display object

Display

Exception

Return value

Object type

Parameter " ... " is invalid

Error

Supplementary explanation

  • Specify addSymbol method at the "Beginning of the row".
  • Can be used when the layout is specified in addCreateScreenCustom method.
  • In case there is overlapping with the display of text or image, the two-dimensional symbol is displayed right in front.
  • If the two-dimensional symbol data specified in data is not in accordance with the type of the two-dimensional symbol specified in type, the two-dimensional symbol is not displayed.
  • If quiet zone assignment is enabled, a dot white margin (quiet zone) that is four times the value specified in width is added at the top, bottom, left, and right of the two-dimensional symbol.
  • To enable quiet zone assignment, specify a value in dotX and dotY, with top left of the quiet zone as the origin.
 

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

Jump to the top