Star WebPRNT User's Manual

StarWebPrintBuilder.js

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

コンストラクタ

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

メソッド

名称説明
createAlignmentElement位置揃えエレメントを生成します。
createBarcodeElementバーコードエレメントを生成します。
createBitImageElementビットイメージエレメントを生成します。
createCutPaperElement用紙カットエレメントを生成します。
createFeedElement用紙送りエレメントを生成します。
createInitializationElement初期化エレメントを生成します。
createLogoElementロゴエレメントを生成します。
createPdf417ElementPDF417エレメントを生成します。
createPeripheralElement外部機器エレメントを生成します。
createQrCodeElementQRコードエレメントを生成します。
createRawDataElement *1生データエレメントを生成します。
createRuledLineElement横罫線エレメントを生成します。
createSoundElementブザーエレメントを生成します。
createTextElementテキストエレメントを生成します。

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

機種別対応リスト

POSプリンター
名称FVP10TSP650IITSP700IITSP800IImPOPmC-Print2mC-Print3
createAlignmentElement
createBarcodeElement
createBitImageElement
createCutPaperElement
createFeedElement
createInitializationElement*1
createLogoElement
createPdf417Element
createPeripheralElement
createQrCodeElement
createRawDataElement
createRuledLineElement
createSoundElement-
createTextElement*2

*1 Bluetoothプリンターはコマンドの初期化のみ実施

*2 国際文字が日本モデルは日本固定、韓国モデルは韓国固定

モバイルプリンター (ESC/POS)
名称SM-S210iSM-S220i
(Jpモデル以外)
SM-S230iSM-T300iSM-T400i
createAlignmentElement*1
createBarcodeElement
createBitImageElement
createCutPaperElement*2-----
createFeedElement
createInitializationElement*3
createLogoElement*4
createPdf417Element*5
createPeripheralElement*6-----
createQrCodeElement*7
createRawDataElement
createRuledLineElement
createSoundElement*6-----
createTextElement*8

*1 テキストデータのみ有効

*2 用紙カットを行わない

*3 コマンドの初期化のみ実施

*4 ロゴ番号1~255を指定した時に、0~254番のロゴを印字

*5 lineパラメータ無効

*6 コマンド未生成

*7 modelパラメータ無効

*8 fontパラメータ無効

モバイルプリンター (StarPRNT)
名称SM-S210iSM-S220i
(Jpモデル以外)
SM-S230iSM-T300iSM-T400iSM-L200SM-L300
createAlignmentElement*1
createBarcodeElement
createBitImageElement
createCutPaperElement*2-------
createFeedElement
createInitializationElement*3
createLogoElement*4
createPdf417Element*5
createPeripheralElement*6-------
createQrCodeElement*7
createRawDataElement
createRuledLineElement
createSoundElement*6-------
createTextElement

*1 テキストデータのみ有効

*2 用紙カットを行わない

*3 コマンドの初期化のみ実施

*4 ロゴ番号と印字ロゴの対応表はこちらをご参照ください。

*5 lineパラメータ無効

*6 コマンド未生成

*7 modelパラメータ無効

StarWebPrintBuilder

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

構文

StarWebPrintBuilder();

名前付き引数

名称説明省略時
----

戻り値

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

createAlignmentElement

位置揃えエレメントを生成します。

構文

createAlignmentElement(args);

名前付き引数

名称説明省略時
poistion 位置揃え指定
  • 'left' … 左揃え
  • 'center' … 中央揃え
  • 'right' … 右揃え
String 'left'

戻り値

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

createBarcodeElement

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

構文

createBarcodeElement(args);

名前付き引数

名称説明省略時
symbology シンボル
  • 'UPCE' … UPC-E
  • 'UPCA' … UPC-A
  • 'JAN8' … JAN/EAN8
  • 'JAN13' … JAN/EAN13
  • 'Code39' … Code39
  • 'ITF' … ITF
  • 'Code128' … Code128
  • 'Code93' … Code93
  • 'NW7' … NW-7
String 'UPCE'
width
  • 'width2' … 最小モジュール2ドット
  • 'width3' … 最小モジュール3ドット
  • 'width4' … 最小モジュール4ドット
  • 'width_mode1' … モード1
  • 'width_mode2' … モード2
  • 'width_mode3' … モード3
  • 'width_mode4' … モード4
  • 'width_mode5' … モード5
  • 'width_mode6' … モード6
  • 'width_mode7' … モード7
  • 'width_mode8' … モード8
  • 'width_mode9' … モード9
※コマンド仕様書参照
String 'width3'
height高さ(ドット単位指定)Number162
hriHRIキャラクタ
  • true … HRIキャラクタあり
  • false … HRIキャラクタなし
Booleantrue
dataバーコードデータ
※コマンド仕様書参照
String省略不可

戻り値

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

    var request = builder.createBarcodeElement({symbology:'JAN13', width:'width2', height:40, hri:false, data:'012345678901'});
}
// -->
</script>

createBitImageElement

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

構文

createBitImageElement(args);

名前付き引数

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

戻り値

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

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

createCutPaperElement

用紙カットエレメントを生成します。

構文

createCutPaperElement(args);

名前付き引数

名称説明省略時
typeカット種
  • 'full' … フルカット
  • 'partial' … パーシャルカット
String'full'
feedカット前の用紙送り
  • true … 用紙送りあり
  • false … 用紙送りなし
Booleantrue

戻り値

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

    var request = builder.createCutPaperElement({feed:true, type:'partial'});
}
// -->
</script>

createFeedElement

用紙送りエレメントを生成します。

構文

createFeedElement(args);

名前付き引数

名称説明省略時
line行単位紙送り量(行単位指定)Number0
unitドット単位紙送り量(ドット単位指定)Number0

戻り値

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

初期化エレメントを生成します。

構文

createInitializationElement(args);

名前付き引数

名称説明省略時
reset ハードウェアリセット
  • true … ハードウェアリセット実施
  • false … ハードウェアリセット未実施(コマンドの初期化のみ)
Booleanfalse
print ハードウェアリセット後の自己印字
  • true …ハードウェアリセット後の自己印字実施
  • false … ハードウェアリセット後の自己印字未実施
Booleanfalse

戻り値

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

createLogoElement

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

構文

createLogoElement(args);

名前付き引数

名称説明省略時
number登録番号Number1
width
  • 'single' … 等倍幅
  • 'double' … 2倍幅
String'single'
height高さ
  • 'single' … 等倍高
  • 'double' … 2倍高
String'single'

戻り値

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

createPdf417Element

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

構文

createPdf417Element(args);

名前付き引数

名称説明省略時
lineライン数
※コマンド仕様書参照
Number0
columnカラム数
※コマンド仕様書参照
Number0
level セキュリティレベル
  • 'level0' … セキュリティレベル0
  • 'level1' … セキュリティレベル1
  • 'level2' … セキュリティレベル2
  • 'level3' … セキュリティレベル3
  • 'level4' … セキュリティレベル4
  • 'level5' … セキュリティレベル5
  • 'level6' … セキュリティレベル6
  • 'level7' … セキュリティレベル7
  • 'level8' … セキュリティレベル8
String'level1'
moduleモジュールサイズ(ドット単位指定)Number2
aspectアスペクト比Number3
dataPDF417データ
※コマンド仕様書参照
String省略不可

戻り値

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

createPeripheralElement

外部機器エレメントを生成します。

構文

createPeripheralElement(args);

名前付き引数

名称説明省略時
channel外部機器
  • 1 … チャンネル1番
  • 2 … チャンネル2番(通電時間/ディレイ時間無効)
Number1
on通電時間(1mSec単位指定)Number200
offディレイ時間(1mSec単位指定)Number200

戻り値

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

createQrCodeElement

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

構文

createQrCodeElement(args);

名前付き引数

名称説明省略時
modelモデル
  • 'model1' … モデル1
  • 'model2' … モデル2
String'model2'
level誤り訂正レベル
  • 'level_l' … 誤り訂正レベルL
  • 'level_m' … 誤り訂正レベルM
  • 'level_q' … 誤り訂正レベルQ
  • 'level_h' … 誤り訂正レベルH
String'level_l'
cellセルサイズ(ドット単位指定)Number3
dataQRコードデータ
※コマンド仕様書参照
String省略不可

戻り値

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

createRawDataElement

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

構文

createRawDataElement(args);

名前付き引数

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

戻り値

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

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

createRuledLineElement

横罫線エレメントを生成します。

構文

createRuledLineElement(args);

名前付き引数

名称説明省略時
thickness 線種
  • 'thin' … 細線
  • 'medium' … 中線
  • 'thick' … 太線
  • 'double_thin' … 二重細線
  • 'double_medium' … 二重中線
  • 'double_thick' … 二重太線
String'medium'
width長さ(ドット単位指定)Number832

戻り値

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

createSoundElement

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

構文

createSoundElement(args);

名前付き引数

名称説明省略時
channel外部機器
  • 1 … チャンネル1番
  • 2 … チャンネル2番
Number1
repeat繰り返し回数Number1

戻り値

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

createTextElement

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

構文

createTextElement(args);

名前付き引数

名称説明省略時
codepageコードページ
  • 'utf8' … UTF-8
  • 'cp437' … コードページ437
  • 'cp737' … コードページ737
  • 'cp772' … コードページ772
  • 'cp774' … コードページ774
  • 'cp851' … コードページ851
  • 'cp852' … コードページ852
  • 'cp855' … コードページ855
  • 'cp857' … コードページ857
  • 'cp858' … コードページ858
  • 'cp860' ~ 'cp866' … コードページ860 ~ 866
  • 'cp869' … コードページ869
  • 'cp874' … コードページ874
  • 'cp928' … コードページ928
  • 'cp932' … コードページ932(Katakana)
  • 'cp998' … コードページ998(Normal)
  • 'cp999' … コードページ999
  • 'cp1001' … コードページ1001
  • 'cp1250' ~ 'cp1252' … コードページ1250 ~ 1252
  • 'cp2001' … コードページ2001
  • 'cp3001' … コードページ3001
  • 'cp3002' … コードページ3002
  • 'cp3011' … コードページ3011
  • 'cp3012' … コードページ3012
  • 'cp3021' … コードページ3021
  • 'cp3041' … コードページ3041
  • 'cp3840' … コードページ3840
  • 'cp3841' … コードページ3841
  • 'cp3843' ~ 'cp3848' … コードページ3843 ~ 3848
  • 'blank' … ユーザ設定(空白コードページ)
  • 'shift_jis' … Shift_JIS
  • 'gb18030' … GB18030
  • 'gb2312' … GB2312
  • 'big5' … Big5
  • 'korea' … korea
String未設定
international国際文字
  • 'usa' … USA
  • 'france' … フランス
  • 'germany' … ドイツ
  • 'uk' … イギリス
  • 'denmark' … デンマーク
  • 'sweden' … スウェーデン
  • 'italy' … イタリア
  • 'spain' … スペイン
  • 'japan' … 日本
  • 'norway' … ノルウェー
  • 'denmark2' … デンマークⅡ
  • 'spain2' … スペインⅡ
  • 'latin_america' … ラテンアメリカ
  • 'korea' … 韓国
  • 'ireland' … アイルランド
  • 'legal' … リーガル
String未設定
characterspace文字間スペース(ドット単位指定)Number未設定
emphasis強調印字
  • true … 強調印字有効
  • false … 強調印字無効
Boolean未設定
invert白黒反転印字
  • true … 白黒反転印字有効
  • false … 白黒反転印字無効
Boolean未設定
linespace行間スペース(ドット単位指定)
  • 24 … 3mm改行
  • 32 … 4mm改行
Number未設定
width横倍率
  • 1 … 等倍幅
  • 2 … 2倍幅
  • 3 … 3倍幅
  • 4 … 4倍幅
  • 5 … 5倍幅
  • 6 … 6倍幅
Number未設定
height縦倍率
  • 1 … 等倍高
  • 2 … 2倍高
  • 3 … 3倍高
  • 4 … 4倍高
  • 5 … 5倍高
  • 6 … 6倍高
Number未設定
fontフォント種
  • 'font_a' … フォントA(12×24ドット)
  • 'font_b' … フォントB(9×24ドット)
※半角フォントのみ対応
String未設定
undelline下線印字
  • true … 下線印字有効
  • false … 下線印字無効
Boolean未設定
binaryバイナリデータエンコーディング
(有効範囲:0x00-0x20,0x26,0x3c,0x3e,0x7f-0xff)
  • true … dataのバイナリデータ指定をそのまま保持
  • false … dataのバイナリデータ指定に対する
               JavaScriptにおけるUTFエンコーディング
Booleanfalse
dataテキストデータString-

戻り値

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