Star webPRNT SDK

https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/
Admin
Star webPRNT SDK lets developers print receipts directly from web browsers on various devices using...
Tokens:84,750
Snippets:527
Trust Score:9.9
Update:6 hours ago
Show doc for...
Tokens:
Raw
### createPeripheralElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a Peripheral (Drawer) element using the StarWebPrintBuilder. The example sets channel, on, and off parameters.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

    var request = builder.createPeripheralElement({channel:1, on:200, off:200});
}
// -->
</script>
```

--------------------------------

### StarWebPrintBuilder constructor example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a new StarWebPrintBuilder object. The example shows the required script include and the constructor call.

```JavaScript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();
}
// -->
</script>
```

--------------------------------

### createUPCE example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a UPCE barcode module list. The example shows creating a StarBarcodeEncoder and calling createUPCE with data '01234500006'.

```html
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var encoder = new StarBarcodeEncoder();

　　var lineImage = encoder.createUPCE({data:'01234500006'});
}
// -->
</script>
```

--------------------------------

### createQrCodeElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a QR code element using the StarWebPrintBuilder. The example sets model, level, cell, and data parameters.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createQrCodeElement({model:'model2', level:'level_l', cell:3, data:'http://www.starmicronics.com/'});
}
// -->
</script>
```

--------------------------------

### write method example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Example for the write method. It creates a StarWebPrintExtManager instance and defines an onWrite function that calls manager.write with a url and request object.

```javascript
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onWrite(url, request) {
    manager.write({url:url, request:request});
}
// -->
</script>
```

--------------------------------

### StarWebPRNTExtManager claim request example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPRNTExtManagerRequestElement.htm

Example of a claim request to start a connection with StarWebPrintExtManager. The request_type attribute is set to 'claim' and polling_timeout to 30000 milliseconds.

```xml
<root>
      <extmanager request_type="claim" polling_timeout="30000"></extmangater>
</root>
```

--------------------------------

### createLogoElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a Logo element with number, width, and height parameters. The example shows a builder instance and a call to createLogoElement({number:1, width:'single', height:'single'}).

```JavaScript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

    var request = builder.createLogoElement({number:1, width:'single', height:'single'});
}
// -->
</script>
```

--------------------------------

### createAlignmentElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates an alignment element with position 'center'. The example shows the builder instantiation and the method call.

```JavaScript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createAlignmentElement({position:'center'});
}
// -->
</script>
```

--------------------------------

### createTextElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Example of using createTextElement to create a text element with specified parameters. The example loads the StarWebPrintBuilder.js library and calls createTextElement with a data string 'Star Micronics\n'.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createTextElement({codepage:'cp998', international:'usa', characterspace:0, emphasis:false, invert:false, linespace:32, width:1, height:1, font:'font_a', underline:false, data:'Star Micronics\n'});
}
// -->
</script>
```

--------------------------------

### StarBarcodeEncoder constructor example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a new StarBarcodeEncoder object. The example shows the required script include and the constructor call inside an onBuild function.

```html
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarBarcodeEncoder();
}
// -->
</script>
```

--------------------------------

### createToneElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a tone element. The 'contrast' parameter accepts values from 'minus3' to 'plus3' with 'default' as the default. The example uses contrast:'default'.

```javascript
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createToneElement({contrast:'default'});
}
// -->
</script>
```

--------------------------------

### createFeedElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a Feed element with line and unit parameters. The example shows a builder instance and a call to createFeedElement({line:2, unit:8}).

```JavaScript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createFeedElement({line:2, unit:8});
}
// -->
</script>
```

--------------------------------

### createInitializationElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates an Initialization element with reset and print flags set to true. The example shows a builder instance and a call to createInitializationElement({reset:true, print:true}).

```JavaScript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createInitializationElement({reset:true, print:true});
}
// -->
</script>
```

--------------------------------

### onReceive event example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Example for the onReceive event. It sets manager.onReceive to handle the response, checking managerSuccess and managerClaim, and displays the managerCode via alert.

```javascript
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.onReceive = function(response) {
        var msg;
        if (response.managerSuccess == 'true' && response.managerClaim == 'true') {
            msg = 'Connected\n\n'
        }
        else {
            msg = 'Not connected\n\n'
        }

        msg = '- onReceive -\n\n';
        msg += 'ManagerSuccess : [ ' + response.managerSuccess + ' ]\n';
        msg += 'ManagerCode    : [ ' + response.managerCode + ' ]\n';

        alert(msg);
    }

    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### createUPCA example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a UPCA barcode module list. The example shows creating a StarBarcodeEncoder and calling createUPCA with data '01234567890'.

```html
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var encoder = new StarBarcodeEncoder();

　　var lineImage = encoder.createUPCA({data:'01234567890'});
}
// -->
</script>
```

--------------------------------

### createHorizontalTabElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a Horizontal tab element using the StarWebPrintDisplayBuilder. The example shows the required script includes and the builder instantiation, then calls createHorizontalTabElement() with no arguments.

```html
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createHorizontalTabElement();
}
// -->
</script>
```

--------------------------------

### createSoundWithSettingElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a melody speaker element with sound storage area, sound number, and volume settings. The example uses sound_storage_area 1, sound_number 0, and volume 'volume6'. Note: Do not use with anything other than the melody speaker connected.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
 <!--
function onBuild() {
    var builder = new StarWebPrintBuilder();
    var request = builder.createSoundWithSettingElement({'sound_storage_area':1,'sound_number':0,'volume':'volume6'}); 
// -->
</script>
```

--------------------------------

### createPdf417Element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a PDF417 element using the StarWebPrintBuilder. The example sets level, line, column, module, aspect, and data parameters.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createPdf417Element({level:'level1', line:0, column:0, module:2, aspect:3, data:'http://www.starmicronics.com/'});
}
// -->
</script>
```

--------------------------------

### onReceive event example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintTrader-js.htm

Demonstrates handling the onReceive event, which fires on successful communication. The example builds a message from the response properties (traderSuccess, traderCode, traderStatus, status, responseText) and displays it via alert. It also includes an onError handler.

```javascript
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
　　var trader = new StarWebPrintTrader({url:url});

　　trader.onReceive = function (response) {
        var msg = '- onReceive -\n\n';

        msg += 'TraderSuccess:' + response.traderSuccess + '\n';

　      msg += 'TraderCode:' + response.traderCode + '\n';

        msg += 'TraderStatus:' + response.traderStatus + '\n';

        msg += 'Status:' + response.status + '\n';

　      msg += 'ResponseText:' + response.responseText;

        alert(msg);
　　}

    trader.onError = function (response) {
        var msg = '- onError -\n\n';

        msg += '\tStatus:' + response.status + '\n';

        msg += '\tResponseText:' + response.responseText;

        alert(msg);
    }

    trader.sendMessage({request:request});
}
// -->
</script>
```

--------------------------------

### createTurnOnElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a backlight element. The 'type' parameter is 'true' for backlight ON (default) or 'false' for OFF. The example uses type:'true'.

```javascript
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createTurnOnElement({type:'true'});
}
// -->
</script>
```

--------------------------------

### createBitImageElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a Bit image element from a canvas context. The example passes a canvas 2D context and drawing area parameters (x, y, width, height) to createBitImageElement. The context, width, and height are required; x and y default to 0.

```html
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createBitImageElement({context:canvas.getContext('2d'),  x:0, y:0, width:160, height:40});
}
// -->
</script>
```

--------------------------------

### onDisplayImpossible Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Assigns the onDisplayImpossible callback to alert when the display cannot be used. The example includes the required script tags and calls manager.connect({url:url}) inside the onConnect function.

```html
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.onDisplayImpossible = function() {
        alert('onDisplayImpossible');
    }

    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### createCursorElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a cursor element. The 'position' can be 'home' or 'specified', 'mode' can be 'off', 'blink', or 'on'. The example uses position:'home' and mode:'blink'.

```javascript
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createCursorElement({position:'home', mode:'blink'});
}
// -->
</script>
```

--------------------------------

### createBackSpaceElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a Back Space element using the StarWebPrintDisplayBuilder. The example shows the required script includes and the builder instantiation, then calls createBackSpaceElement() with no arguments.

```html
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createBackSpaceElement();
}
// -->
</script>
```

--------------------------------

### createSoundElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a sound element for a buzzer with specified channel and repeat count. The example uses channel 1 and repeat 1. Note: Do not use with anything other than the buzzer connected.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createSoundElement({channel:1, repeat:1});
}
// -->
</script>
```

--------------------------------

### onDisplayConnect Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Assigns the onDisplayConnect callback to alert when the barcode reader is connected. The example includes the required script tags and calls manager.connect({url:url}) inside the onConnect function.

```html
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.onDisplayConnect = function() {
        alert('onDisplayConnect');
    }

    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### onWrite Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Assigns the onWrite callback to alert when data transmission is complete. The example includes the required script tags and calls manager.write({url:url, request:request}) inside the onWrite function.

```html
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onWrite(url, request) {
    manager.onWrite = function() {
        alert('onWrite');
    }

    manager.write({url:url, request:request});
}
// -->
</script>
```

--------------------------------

### onAccessoryDisconnect Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Assigns the onAccessoryDisconnect callback to alert when the Bluetooth accessory disconnects. The example includes the required script tags and calls manager.connect({url:url}) inside the onConnect function.

```html
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.onAccessoryDisconnect = function() {
        alert('onAccessoryDisconnect');
    }

    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### createTextElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a Text element with specified codepage, international characters, and data. The example passes {codepage:'cp437', international:'usa', data:'Star Micronics'} to createTextElement. The codepage and international parameters default to 'Unchanged' if omitted.

```html
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createTextElement({codepage:'cp437', international:'usa', data:'Star Micronics'});
}
// -->
</script>
```

--------------------------------

### Backspace element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayRequestElement.htm

Example of a backspace element within an extmanager request.

```xml
<root >
　　<extmanager request_type="write">
        <backspace/>
    </extmangater>
</root>
```

--------------------------------

### Create StarWebPrintDisplayBuilder instance

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Example of creating a StarWebPrintDisplayBuilder object. Includes the script tag to load the StarWebPrintDisplayBuilder.js file and a function that instantiates the builder.

```html
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();
}
// -->
</script>
```

--------------------------------

### Horizontal tab element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayRequestElement.htm

Example of a horizontal_tab element within an extmanager request.

```xml
<root >
　　<extmanager request_type="write">
        <horizontal_tab/>
    </extmangater>
</root>
```

--------------------------------

### Return element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayRequestElement.htm

Example of a return element with type 'crlf' within an extmanager request.

```xml
<root >
　　<extmanager request_type="write">
        <return type="crlf"/>
    </extmangater>
</root>
```

--------------------------------

### Extmanager element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayRequestElement.htm

Example of an extmanager element with request_type 'write' and a text element inside.

```xml
<root >
　　<extmanager request_type="write">
        <text codepage="cp437" international="usa">Star Micronics</text>
</extmangater>
</root>
```

--------------------------------

### createITF Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a module list for an ITF barcode. The data parameter is required and must be a string. The return value uses 'N' for narrow bar, 'n' for narrow space, 'W' for wide bar, and 'w' for wide space.

```JavaScript
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var encoder = new StarBarcodeEncoder();

　　var lineImage = encoder.createITF({data:'0123456789'});
}
// -->
</script>
```

--------------------------------

### feed element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintRequestElement.htm

Example of the feed element with line and unit attributes. The value is ignored.

```xml
<root>
　　<feed line='2' unit='8'/>
</root>
```

--------------------------------

### cutPaper element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintRequestElement.htm

Example of the cutPaper element with feed and type attributes. The value is ignored.

```xml
<root>
　　<cutpaper feed='true' type='partial'/>
</root>
```

--------------------------------

### createInitializationElement(args)

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates an Initialization element that can perform hardware reset and self-printing. Returns the created element string.

```APIDOC
## createInitializationElement(args)

### Description
Creates an Initialization element that can perform hardware reset and self-printing.

### Method
createInitializationElement(args)

### Parameters
- **reset** (Boolean) - Optional (default false) - Specifies hardware reset. true: Execute hardware reset, false: Not execute hardware reset (Only command initialization).
- **print** (Boolean) - Optional (default false) - Self printing after hardware reset. true: Execute self print, false: Not execute self print.

### Return Value
- **String** - Created element character string.

### Example
```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();
    var request = builder.createInitializationElement({reset:true, print:true});
}
// -->
</script>
```
```

--------------------------------

### onPrinterImpossible event example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Example for the onPrinterImpossible event. It sets manager.onPrinterImpossible to show an alert when the printer cannot be used.

```javascript
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.onPrinterImpossible = function() {
        alert('onPrinterImpossible');
    }

    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### Create StarWebPrintExtManager and connect

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Example for the StarWebPrintExtManager constructor and connect method. Includes script tags for StarWebPrintTrader.js and StarWebPrintExtManager.js, and a function that calls manager.connect with a URL.

```html
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### barcode element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintRequestElement.htm

Example of the barcode element with symbology, width, hri, and height attributes. The value is the barcode data.

```xml
<root>
　　<barcode symbology='JAN13' width='width2' hri='false' height='40'>012345678901</barcode>
</root>
```

--------------------------------

### bitImage element example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintRequestElement.htm

Example of the bitImage element with width and height attributes. The value is Base64-encoded raster graphic image data.

```xml
<root>
　　<bitimage width='200' height='50'>f////////////////////////////////4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAA/j+AAAAAAAAAAAAAAAAAAAGAGAAAAAAAAP4/gAAAAAAAAAAAAAAAAAAHgBgAAAAAAAD+P4AAAAAAAAAAAAAAAAAAHYAYAAAAAAAA/j+AAAAAAAAAAAAAAAAAADkAGAAAAAAAAP4/gAAAAAAAAAAAAAAAAADnABgAAAAAAAD+P4AAAAAAAAAAAAAAAAADnAAYAAAH///4/j//4AAf9+AAD+HwP/fgBzAAGAAAf///+P4//+AD///+AA/h8f//4BzgABgAAP////j+P//gD////8AP4f/8ACAzgAAYAAP8AAAAAAAAAH/+A//wD+H/wAfgYwAAGAAH4AAAAAAAAAD/wAAf/A/h/AeP47OAABgAB+P///j+P//j/gf/A/4P4eB//y/4wAAYAAfD///4/j//5/h//+D/D+GD/+c8AHAAGAAH4///+P4//+/x///4f4/hD//hM/wYABgAB/B/AAD+P4AH4/8H/D+P4D/AAQ4f9gAYAAP8D/AA/j+AH8f4AP4fz+B/AAE4AH4AGAAA/4H+AP4/gB/H8AB/H8/g/gABYAAAABgAAD/4f8D+P4Afh+AAfw/P4fwAAcAAAAAYAAAH/g/g/j+AH8fwAH8Pz+F4AAEAAAAAGAAAAH/D+P4/gB/H+AB/D8/h+AAAAAAAABgAAAAf4fz+P8Af4/4Gfw/P4fgAAAAAAAAYAAf///j8/j//z+H//n8Pz+H4AAAAAAAAGAAH///w/PYX/8f49/Z3D8/h+AAAAAAAABgAB///8Pz/B//D/B/+fw/P4fgAAAAAAAAYAAAAAAH8f8AAAf+AAH8Pz+H4AAAAAAAAGAAAAAAP+D/8AAD/+AB/D8/h+AAAAAAAABgAB////+AP///AH//+fw/P4fgAAAAAAAAYAAf///+AAf//wAf//n8Pz+H4AAAAAAAAGAAH///4AAAf/8AAf/x/D8/h+AAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAf////////////////////////////////8
=</bitimage>
</root>
```

--------------------------------

### createCode39 Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a module list for a Code39 barcode. The data parameter is required and must be a string. The return value uses 'N' for narrow bar, 'n' for narrow space, 'W' for wide bar, and 'w' for wide space.

```JavaScript
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var encoder = new StarBarcodeEncoder();

　　var lineImage = encoder.createCode39({data:'0123456789'});
}
// -->
</script>
```

--------------------------------

### createClearScreenElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintDisplayBuilder-js.htm

Creates a clear screen element. The 'type' parameter can be 'all' (default) or 'delete_to_end_of_line'. The example uses type:'all'.

```javascript
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createClearScreenElement({type:'all'});
}
// -->
</script>
```

--------------------------------

### connect(args)

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Starts management of the printer connection. Accepts url, pollingTimeout, and pollingInterval parameters.

```APIDOC
## connect(args)

### Description
Starts management of the printer connection. Accepts url, pollingTimeout, and pollingInterval parameters.

### Syntax
`connect(args);`

### Parameters
- **url** (String) - Required - Specifies Star webPRNT endpoint URL. Note: When omitted, it should be specified by StarWebPrintExtManager constructor.
- **pollingTimeout** (Number) - Optional - The time out for polling of Claim management (ms unit). Note: When omitted, it should be specified by StarWebPrintExtManager constructor.
- **pollingInterval** (Number) - Optional - The sending interval time for polling of Claim management (ms unit). Note: When omitted, it should be specified by StarWebPrintExtManager constructor.

### Return Value
- **Boolean** - true … Success, false … Failed

### Example
```javascript
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.connect({url:url});
}
// -->
</script>
```
```

--------------------------------

### createJAN13 Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a module list for a JAN/EAN13 barcode. The data parameter is required and must be a string. The return value uses '1' for bar and '0' for space.

```JavaScript
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var encoder = new StarBarcodeEncoder();

　　var lineImage = encoder.createJAN13({data:'01234567890'});
}
// -->
</script>
```

--------------------------------

### onError event example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintExtManager-js.htm

Example for the onError event. It sets manager.onError to handle errors, using args.status and args.responseText to build an alert message.

```javascript
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>

<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();

function onConnect(url) {
    manager.onReceive = function(response) {
        var msg;
        if (response.managerSuccess == 'true' && response.managerClaim == 'true') {
            msg = 'Connected\n\n'
        }
        else {
            msg = 'Not connected\n\n'
        }

        msg = '- onReceive -\n\n';
        msg += 'ManagerSuccess : [ ' + response.managerSuccess + ' ]\n';
        msg += 'ManagerCode    : [ ' + response.managerCode + ' ]\n';

        alert(msg);
    }

    manager.onError = function(response) {
        var msg;

        msg = 'onError!'         + '\n';
        msg += '  Status:'       + args.status + '\n';
        msg += '  ResponseText:' + args.responseText;

        alert(msg);
    }

    manager.connect({url:url});
}
// -->
</script>
```

--------------------------------

### timeout property example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintTrader-js.htm

Sets the communication timeout for StarWebPrintTrader in milliseconds. The example sets trader.timeout to 120000 (120 seconds) before sending a message.

```javascript
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
　　var trader = new StarWebPrintTrader({url:url});

       trader.timeout = 120000;

    trader.sendMessage({request:request});
}
// -->
</script>
```

--------------------------------

### createRuledLineElement example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintBuilder-js.htm

Creates a horizontal ruled line element with specified thickness and width. The example uses thickness 'thin' and width 200.

```javascript
<script type='text/javascript' src='js/StarWebPrintBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintBuilder();

　　var request = builder.createRuledLineElement({thickness:'thin', width:200});
}
// -->
</script>
```

--------------------------------

### createNW7 Example

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarBarcodeEncoder-js.htm

Creates a module list for an NW7 barcode. The data parameter is required and must be a string. The return value uses 'N' for narrow bar, 'n' for narrow space, 'W' for wide bar, and 'w' for wide space.

```JavaScript
<script type='text/javascript' src='js/StarBarcodeEncoder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var encoder = new StarBarcodeEncoder();

　　var lineImage = encoder.createUPCE({data:'A0123456789B'});
}
// -->
</script>
```

--------------------------------

### Create StarWebPrintTrader and send message

Source: https://www.star-m.jp/products/s_print/sdk/webprnt/manual/en/_StarWebPrintTrader-js.htm

Example for the StarWebPrintTrader constructor and sendMessage method. It creates a trader with a URL and sends a print request. The script includes the StarWebPrintTrader.js library.

```javascript
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
　　var trader = new StarWebPrintTrader({url:url});

    trader.sendMessage({request:request});
}
// -->
</script>
```
Tokens:
Raw