Star WebPRNT User's Manual

StarWebPRNTDisplay送信エレメント


名称説明WebPRNT
Browser
WebPRNT対応
Starプリンター
<root>ルートエレメント-○*1
<extmanager>StarWebPRNTExtManagerエレメント-○*1
<backspace>バックスペースエレメント-○*1
<horizontal_tab>水平タブエレメント-○*1
<return>改行エレメント-○*1
<bitimage>ビットイメージエレメント-○*1
<text>テキストエレメント-○*1
<clear>画面消去エレメント-○*1
<cursor>カーソルエレメント-○*1
<tone>トーンエレメント-○*1
<turnon>バックライトエレメント-○*1
<rawdata>*2生データエレメント-○*1

*1 IFBD-HI01X/02X使用時のみ対応しています。(日本国内では販売していません。)

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

<root>

ルートエレメント

属性

名称説明省略時
---

説明
StarWebPRNTExtManager送信エレメント列
<root >
  <extmanager request_type="write"></extmangater>
</root>

<extmanager>

StarWebPRNTExtManagerエレメント

属性

名称説明省略時
request_typeStarWebPRNTExtManagerに対する要求
  • 'claim' …接続開始要求
  • 'read' …受信要求
  • 'write' …送信要求
  • 'release' …切断要求
省略不可
polling_timeoutポーリングのタイムアウト時間[ms]10000
claimidclaimid管理用ID省略不可 *1

*1 request_typeが、'claim'か'write'の時のみ省略可能

説明
StarWebPRNTDisplay送信エレメント列
<root >
  <extmanager request_type="write">
        <text codepage="cp437" international="usa">Star Micronics</text>
</extmangater>
</root>

<backspace>

バックスペースエレメント

属性

名称説明省略時
---

説明
無視
<root >
  <extmanager request_type="write">
        <backspace/>
    </extmangater>
</root>

<horizontal_tab>

水平タブエレメント

属性

名称説明省略時
---

説明
無視
<root >
  <extmanager request_type="write">
        <horizontal_tab/>
    </extmangater>
</root>

<return>

改行エレメント

属性

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

説明
無視
<root >
  <extmanager request_type="write">
        <return type="crlf"/>
    </extmangater>
</root>

<bitimage>

ビットイメージエレメント

属性

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

説明
ラスタグラフィックイメージデータ
※Base64エンコード
<root >
  <extmanager request_type="write">
        <bitimage width="160" height="40">///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////gcD/////////////////z/////+BwP////////////////8P/////4HA/////////////////k//////gcD////////////////83/////+BwP////////////////Ef/////4HA////////////////xn//AAADgcAAf/4AA//4Hg+AAP+M//gAAAOBwAB/4AAAf/geDAAA/jH/8AAAA4HAAH+AAAAP+B4AB/78x//Af////////AAfgAP4HgB/4P3P/4H////////4A//8APgeB/HA4Mf/gYAAA4HAAHAPgB8AeB4fAAKAc/+DgAADgcAAYDgAA8A4HngAYh/4/4GAAAOBwABAcAAA4Dge4AB6YD7/gfA//4HA/8DgDwBwOB/Af/uOAD/AfgP/gcD/gcB/4HgYH4H/+j/4P/APgH+BwP+BwP/wOBgfA//4/////ADgH4HA/4PB//A8GB4H//n/////AHwPgcD/gcD/8DwYHg//+//////wDwOBwP+BwH/wPBgeD/////////wHAYHAf4DgHzA8GB4P//////+AAAGBgcAAwPAAMDwYHg///////4AAAYGBwADgOAAwPBgeD///////gAADgYDwAPAeADA8GB4P//////////8BgD//8AP/8DwYHg///////////APAB//4AH/wPBgeD///////gAAAD/AAAP8AADA8GB4P//////+AAAA//gAA/8AAMDwYHg///////4AAAf//wAD/+ABwPBgeD//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8=</bitimage>
    </extmangater>
</root>

<text>

テキストエレメント

属性

名称説明省略時
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
未設定
international国際文字
  • 'usa' … USA
  • 'france' … フランス
  • 'germany' … ドイツ
  • 'uk' … イギリス
  • 'denmark' … デンマーク
  • 'sweden' … スウェーデン
  • 'italy' … イタリア
  • 'spain' … スペイン
  • 'japan' … 日本
  • 'norway' … ノルウェー
  • 'denmark2' … デンマークⅡ
  • 'spain2' … スペインⅡ
  • 'latin_america' … ラテンアメリカ
  • 'korea' … 韓国
未設定

説明
テキストデータ
<root >
  <extmanager request_type="write">
        <text codepage="cp437" international="usa">Star Micronics</text>
    </extmangater>
</root>

<clear>

画面消去エレメント

属性

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

説明
無視
<root >
  <extmanager request_type="write">
        <clear type="all"/>
    </extmangater>
</root>

<cursor>

カーソルエレメント

属性

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

説明
生成したエレメント文字列String
<root >
  <extmanager request_type="write">
        <cursor position="home" mode="blink"/>
    </extmangater>
</root>

<tone>

トーンエレメント

属性

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

説明
無視
<root >
  <extmanager request_type="write">
        <tone contrast="default"/>
    </extmangater>
</root>

<turnon>

バックライトエレメント

属性

名称説明省略時
typeバックライトのON/OFFを指定
  • 'on' … バックライトオン
  • 'off' … バックライトオフ
'on'

説明
無視
<root >
  <extmanager request_type="write">
        <turnon type="on"/>
    </extmangater>
</root>

<rawdata>

生データエレメント

属性

名称説明省略時
---

説明
生データ
※Base64エンコード
<root >
  <extmanager request_type="write">
        <rawdata>MTIzNDU=</rawdata>
    </extmangater>
</root>
  • このメソッドによりディスプレイ特有のコマンドを送信することができます。
  • 使用する場合は、ディスプレイ機種依存が発生する恐れがあるため、使用機種を変更する際は必ず動作確認をしてください。