Star webPRNT User's Manual

StarWebPrintDisplayBuilder.js

StarWebPRNT Display送信エレメントを生成します。

コンストラクタ

名称説明
StarWebPrintDisplayBuilderStarWebPrintDisplayBuilderオブジェクトを生成します。

メソッド

名称説明
createBackSpaceElementバックスペースエレメントを生成します。
createHorizontalTabElement水平タブエレメントを生成します。
createReturnElement改行エレメントを生成します。
createBitImageElementビットイメージエレメントを生成します。
createTextElementテキストエレメントを生成します。
createClearScreenElement画面消去エレメントを生成します。
createCursorElementカーソルエレメントを生成します。
createToneElementトーンエレメントを生成します。
createTurnOnElementバックライトエレメントを生成します。
createRawDataElement *1生データエレメントを生成します。

*1 このメソッドによりディスプレイ特有のコマンドを送信することができます。
  使用する場合は、ディスプレイ機種依存が発生する恐れがあるため、使用機種を変更する際は必ず動作確認をしてください。

機種別対応リスト

各機種でサポートされているStar webPRNT機能がどのメソッドをサポートするかを示します。

  • LAN … プリンタのStar webPRNT機能
  • LAN(HE) … IFBD-HE07X/08XのStar webPRNT機能
  • LAN(HI) … IFBD-HI01X/02XのStar webPRNT機能(日本国内では販売していません。)
  • BR … Star webPRNT Browser (Bluetooth)
  • BR(B+U) … Star webPRNT Browser(Bluetooth/USB)
  • BR(U) … Star webPRNT Browser(USB, Androidのみ)
POSプリンター(mCollection/TSP100IV)
名称mC-Print2mC-Print3mPOPTSP100IV
LANBR(B+U)LANBR(B+U)BR(B+U)LANBR(U)
createBackSpaceElement○*1*2○*1*2○*2
createHorizontalTabElement○*1*2○*1*2○*2
createReturnElement○*1*2○*1*2○*2
createBitImageElement○*1*2○*1*2○*2
createTextElement○*1*2○*1*2○*2
createClearScreenElement○*1*2○*1*2○*2
createCursorElement○*1*2○*1*2○*2
createToneElement○*1*2○*1*2○*2
createTurnOnElement○*1*2○*1*2○*2
createRawDataElement○*1*2○*1*2○*2

*1 プリンターファームウェア Ver.2.1以降で対応。

*2 SSL通信には非対応です。Webアプリをhttpsで公開する場合にはディスプレイを使用することはできません。


POSプリンター(レガシープリンター)
名称TSP650II/
TSP650IISK*1
TSP700IITSP800IIFVP10
LANBRLANBRLANBRLANBR
HEHIHEHIHEHIHE
createBackSpaceElement--------
createHorizontalTabElement--------
createReturnElement--------
createBitImageElement--------
createTextElement--------
createClearScreenElement--------
createCursorElement--------
createToneElement--------
createTurnOnElement--------
createRawDataElement--------

*1 TSP650IISK : 日本国内では販売しておりません。


モバイルプリンター (ESC/POS)
名称SM-
S210i
SM-
S220i
(Jpモデル以外)
SM-
S230i
SM-
T300i
SM-
T400i
BRBRBRBRBR
createBackSpaceElement-----
createHorizontalTabElement-----
createReturnElement-----
createBitImageElement-----
createTextElement-----
createClearScreenElement-----
createCursorElement-----
createToneElement-----
createTurnOnElement-----
createRawDataElement-----

モバイルプリンター (StarPRNT)
名称SM-
S210i
SM-
S220i
(Jpモデル以外)
SM-
S230i
SM-
T300i
SM-
T400i
SM-
L200
SM-
L300
BRBRBRBRBRBRBR
createBackSpaceElement-------
createHorizontalTabElement-------
createReturnElement-------
createBitImageElement-------
createTextElement-------
createClearScreenElement-------
createCursorElement-------
createToneElement-------
createTurnOnElement-------
createRawDataElement-------

StarWebPrintDisplayBuilder

StarWebPrintDisplayBuilderオブジェクトを生成します。

構文

StarWebPrintDisplayBuilder();

名前付き引数

名称説明省略時
----

戻り値

説明
StarWebPrintDisplayBuilderオブジェクトStarWebPrintDisplayBuilder
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();
}
// -->
</script>

createBackSpaceElement

バックスペースエレメントを生成します。

構文

createBackSpaceElement(args);

名前付き引数

名称説明省略時
----

戻り値

説明
生成したエレメント文字列String
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

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

createHorizontalTabElement

水平タブエレメントを生成します。

構文

createHorizontalTabElement();

名前付き引数

名称説明省略時
----

戻り値

説明
生成したエレメント文字列String
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

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

createReturnElement

改行エレメントを生成します。

構文

createReturnElement(args);

名前付き引数

名称説明省略時
type改行タイプ指定
  • 'crlf' … CR+LF(キャリッジリターン+改行)
  • 'cr' … CR(キャリッジリターンのみ)
  • 'lf' … LF(改行のみ)
String'crlf'

戻り値

説明
生成したエレメント文字列String
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createReturnElement({type:'crlf'});
}
// -->
</script>

createBitImageElement

ビットイメージエレメントを生成します。

構文

createBitImageElement(args);

名前付き引数

名称説明省略時
contextHTML5 Canvas 2DコンテキストCanvas省略不可
x描画領域横方向開始位置(ドット単位)Number0
y描画領域縦方向開始位置(ドット単位)Number0
width描画幅 (ドット単位指定)Number省略不可
height描画高さ (ドット単位指定)Number省略不可

戻り値

説明
生成したエレメント文字列String
<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>

createTextElement

テキストエレメントを生成します。

構文

createTextElement(args);

名前付き引数

名称説明省略時
codepage コードページ
  • 'cp437' … コードページ437
  • 'katakana' … カタカナ
  • 'cp850' … コードページ850
  • 'cp852' … コードページ852
  • 'cp858' … コードページ858
  • 'cp860' … コードページ860
  • 'cp863' … コードページ863
  • 'cp865' … コードページ865
  • 'cp866' … コードページ866
  • 'cp1252' … コードページ1252
  • 'shift_jis' … Shift_JIS
  • 'gb2312' … GB2312
  • 'big5' … Big5
  • 'korea' … korea
String未設定
international 国際文字
  • 'usa' … USA
  • 'france' … フランス
  • 'germany' … ドイツ
  • 'uk' … イギリス
  • 'denmark' … デンマーク
  • 'sweden' … スウェーデン
  • 'italy' … イタリア
  • 'spain' … スペイン
  • 'japan' … 日本
  • 'norway' … ノルウェー
  • 'denmark2' … デンマークⅡ
  • 'spain2' … スペインⅡ
  • 'latin_america' … ラテンアメリカ
  • 'korea' … 韓国
String未設定
dataテキストデータString-
binary バイナリデータエンコーディング
(有効範囲:0x00-0x20,0x26,0x3c,0x3e,0x7f-0xff)
  • true … dataのバイナリデータ指定をそのまま保持
  • false … dataのバイナリデータ指定に対する
    JavaScriptにおけるUTFエンコーディング
Booleanfalse
dataテキストデータString-

戻り値

説明
生成したエレメント文字列String
<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>

createClearScreenElement

画面消去エレメントを生成します。

構文

createClearScreenElement(args);

名前付き引数

名称説明省略時
type 消去タイプ指定
  • 'all' … オールクリア
  • 'delete_to_end_of_line' … 現在の行をクリア
String'all'

戻り値

説明
生成したエレメント文字列String
<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>

createCursorElement

カーソルエレメントを生成します。

構文

createCursorElement(args);

名前付き引数

名称説明省略時
positionカーソル位置を指定
  • 'home' … ホームポジションへ移動
  • 'specified' … 指定した位置へ移動
String未設定
xカーソルの横軸位置
※positionにてspecifiedを指定した場合のみ有効となります。
String0
yカーソルの縦軸位置
※positionにてspecifiedを指定した場合のみ有効となります。
String0
modeカーソルの表示パターンを指定
  • 'off' … カーソル非表示
  • 'blink' … カーソル点滅
  • 'on' … カーソル表示
String未設定

戻り値

説明
生成したエレメント文字列String
<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>

createToneElement

トーンエレメントを生成します。

構文

createToneElement(args);

名前付き引数

名称説明省略時
contrast コントラストを指定
  • 'minus3' …コントラスト-3
  • 'minus2' …コントラスト-2
  • 'minus1' …コントラスト-1
  • 'default' …デフォルト
  • 'plus1' …コントラスト+1
  • 'plus2' …コントラスト+2
  • 'plus3' …コントラスト+3
String'default'

戻り値

説明
生成したエレメント文字列String
<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>

createTurnOnElement

バックライトエレメントを生成します。

構文

createTurnOnElement(args);

名前付き引数

名称説明省略時
typeバックライトのオン/オフを指定
  • 'true' … バックライトオン
  • 'false' … バックライトオフ
String'true'

戻り値

説明
生成したエレメント文字列String
<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>

createRawDataElement

生データエレメントを生成します。

構文

createRawDataElement(args);

名前付き引数

名称説明省略時
data生データ
※16進数'\x00'-'\xff'、水平タブ'\t'、改行'\n'、キャリッジリターン'\r'、バックスラッシュ'\\'
String省略不可

戻り値

説明
生成したエレメント文字列String
<script type='text/javascript' src='js/StarWebPrintDisplayBuilder.js'></script>
<script type='text/javascript'>
<!--
function onBuild() {
    var builder = new StarWebPrintDisplayBuilder();

    var request = builder.createRawDataElement({data:'\x30\x31\x32\x33\x34\x35\x36\x37\x38\x39\n'});
}
// -->
</script>
  • このメソッドによりディスプレイ特有のコマンドを送信することができます。
  • 使用する場合は、ディスプレイ機種依存が発生する恐れがあるため、使用機種を変更する際は必ず動作確認をしてください。