バーコードジェネレータオプション

バーコードジェネレータオプションは、文書中に画像として直接バーコードを埋め込むためのオプションです。バーコードフォントなどは必要ありません。

バーコードジェネレータオプションを利用するためには、「AH Formatter バーコードジェネレータオプション」をご購入していただく必要があります。 詳しくは、弊社ウェブサイトを参照してください。

バーコードジェネレータオプションは、以下のバーコードに対応しています。

• QR / MicroQR
• Data Matrix
• PDF417
• 日本郵便カスタマバーコード
• Intelligent Mail® Barcode
• POSTNET
• EAN / JAN
• UPC (UPC-A、UPC-E)
• Interleaved 2of5 (ITF)
• Codabar / NW-7
• Code 39
• Code 128
• GS1-128 / EAN-128

バーコードは、dataスキームを用いて次のように指定します。

<!-- XSL-FO example --/>
<fo:external-graphic src="data:application/vnd.ah-barcode;type=QR;scale=2,Hello%20World!"/>

<!-- HTML example --/>
<img src="data:application/vnd.ah-barcode;type=QR;scale=2,Hello%20World!"/>

ここに、application/vnd.ah-barcodeは専用のメディアタイプです。出力したいバーコードの内容は、上記のように直接文字列として指定することができます。このとき、URIとして不適切な文字を%エンコードで表現することに注意してください。また、Base64で指定することもできます。

<!-- XSL-FO example --/>
<fo:external-graphic src="data:application/vnd.ah-barcode;type=QR;base64,PD94bWwgdmVyc2lv..."/>

<!-- HTML example --/>
<img src="data:application/vnd.ah-barcode;type=QR;base64,PD94bWwgdmVyc2lv..."/>

出力されるバーコードの制御は、メディアタイプのパラメータで行います。パラメータの大文字小文字は区別されません。typeパラメータは必須で、出力バーコードの種類を示します。

バーコードは、常に axf:image-smoothing="false" に強制されます。

注意:	ここでは、バーコードの仕様には立ち入りません。それぞれのバーコードの仕様書を参照してください。

QRは、JIS X 0510:2004 または ISO/IEC 18004:2006 で規格制定されています。バーコードジェネレータオプションでは、QRはModel2にのみ対応しています（Model1には対応していません）。以下のパラメータを指定できます。

パラメータ	値		既定値	内容
type	QR	MicroQR	必須
ver	auto | 1～40	auto | 1～4	auto	バージョン
ecl	auto | L | M | Q | H		auto	エラー訂正レベル
enc	auto | [ N || A || B || K ]		auto	エンコーディング auto NABKと等価 N 数字 0123456789 A 英数字 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ$%*+-./: space B バイト K 漢字（Shift JIS）
mpr	auto | 0～7	auto | 0～3	auto	マスクパタン参照
scale	<正数>		1	１セルの出力サイズ
qz	<非負数>		4 or 2	余白（クワイエットゾーン） 既定値は QR のとき 4、MicroQR のとき 2
out	svg | png		png	出力形式
dpi	<非負数>		0	pngのときの画像解像度（0は指定なし）
color	<色>		black	バーコードの色
bgcolor	<色>		white	バーコードの背景色
charset	<任意文字列>		UTF-8	直接文字列指定のエンコーディング

バージョンverにautoを指定したときは、データの長さによって適切なバージョンが採用されます。

エラー訂正レベルeclにautoを指定したときは、データやバージョンによって適切なエラー訂正レベルが採用されます。

エンコーディング指定encで、auto以外は複数を指定できます。例えば、enc=NAB と指定すれば、これら3種を混合して適切に出力します。指定エンコーディングで出力できなければエラーです。

QRは、白黒パタンがなるべく均一になるようにある種のマスク処理が施されています。マスクパタン参照mpr指定は、この処理を特定のパタンによるものに強制します。自動的に選択されるパタンよりも均一さで劣るかも知れませんが、誤ったQRというわけではありません。

１セルの出力サイズscaleは、svgとpngで指定できる形式が異なります。

• svg

  正の単位付きの実数値を指定できます。0以下は指定できません。指定できる単位は、em、ex、px、pt、pc、in、cm、mm のいずれかです。単位なしはpxとみなされます。

• png

  1以上の整数値を指定できます。単位は付けられません。実数値を指定した場合は、小数点以下は切り捨てられます。

qzで指定できる余白（クワイエットゾーン）は、仕様で QR のとき 4、MicroQR のとき 2 と定められています。これを変更することができますが、これよりも狭くしたときの動作は保証されません。

画像解像度dpi指定は、pngのときのみ有効で、実数値を指定できます。単位は付けられません。

color には transparent 以外の任意の色を指定できますが、pngでは color または bgcolor が指定されているとRGBに変換されます。 bgcolor には transparent も指定できます。

• color=red
• color='#FF0000'
• color='rgb-icc(#Grayscale,0.5)'

この例の場合、適切に値を引用符処理していることに注意してください。引用符処理しないときは、次のように適切に%エスケープ処理をしなければなりません。

• color=%23FF0000
• color=rgb-icc(%23Grayscale%2C0.5)

color に半透明を指定した場合、svg と png ではバーコードの色合いが異なることがあります。svg では背景の bgcolor の上に前景の color が描かれるのに対して、png では bgcolor と color が重なって描かれることはありません。

charset指定は、Base64でなく直接文字列を指定したときのQRに出力するエンコーディングを示します。これは、エンコーディングに漢字が指定されていないときに適用されます。Base64で指定されたデータは、そのまま無変換で出力されます。

注意:	QRが漢字モードで処理できるのは、すべての Shift JIS コードの範囲ではありません。QRリーダによっては、そのような文字を読み取れないことがあります。

注意:	構造的連接には対応していません。

Data Matrix は、ISO/IEC 16022:2006 で規格制定されています。バーコードジェネレータオプションでは、Data Matrix は ECC 200 にのみ対応しています。以下のパラメータを指定できます。

パラメータ	値	既定値	内容
type	DataMatrix | DM	必須
enc	auto | [ A || C || T || X || E || B ] | raw	auto	エンコーディング auto ACTXBと等価 A ASCII C C40 T Text X ANSI X12 E EDIFACT B Base 256 raw 生データ
shape	S | R	S	バーコードの形状 S 正方形 R 長方形
scale	<正数>	1	１セルの出力サイズ ☞ scale
qz	<非負数>	1	余白（クワイエットゾーン）
out	svg | png	png	出力形式
dpi	<非負数>	0	pngのときの画像解像度（0は指定なし）
color	<色>	black	バーコードの色 ☞ color
bgcolor	<色>	white	バーコードの背景色 ☞ color

エンコーディング指定encで、autoまたはraw以外は複数を指定できます。例えば、enc=ACE と指定すれば、これら3種を混合して適切に出力します。このとき、A は指定しなくても常に指定されているとみなされます。
rawは、入力データを無加工で出力します。このとき、以下に注意してください。

• 入力データにエラー訂正コードは含まれません。
• 自動的なパディングは行われないので、データサイズがマトリクスの容量に満たない場合はエラーです。
• 入力データが仕様に適合しているかどうかは関知しません。

画像解像度dpi指定は、pngのときのみ有効で、実数値を指定できます。単位は付けられません。

注意:	構造的連接には対応していません。

PDF417 は、JIS X 0508:2010 または ISO/IEC 15438:2006 で規格制定されています。バーコードジェネレータオプションでは、CompactPDF417、MacroPDF417、MicroPDF417 には対応していません。以下のパラメータを指定できます。

パラメータ	値	既定値	内容
type	PDF417	必須
enc	auto | [ T || N || B ]	auto	エンコーディング auto TNBと等価 T Text N Numeric B Byte
ecl	auto | 0～8	auto	エラー訂正レベル
r	auto | 3～90	auto	行数
c	auto | 1～30	auto	1行の桁数（データのみ）
h	<正数>	3	1行の高さ（幅に対する割合）
scale	<正数>	1	バーの幅 ☞ scale
qzx	<非負数>	2	横方向の余白（クワイエットゾーン）
qzy	<非負数>	2	縦方向の余白（クワイエットゾーン）
out	svg | png	png	出力形式
dpi	<非負数>	0	pngのときの画像解像度（0は指定なし）
color	<色>	black	バーコードの色 ☞ color
bgcolor	<色>	white	バーコードの背景色 ☞ color

エンコーディング指定encで、auto以外は複数を指定できます。例えば、enc=TNB と指定すれば、これら3種を混合して適切に出力します。指定エンコーディングで出力できなければエラーです。

バーコードのサイズを r と c で指定できます。c は、データのみの桁数です。スタートパターン、左行識別子、右行識別子、エンドパターンは含みません。r も c も指定しなかった場合は、必要なサイズが計算されます。どちらか一方を指定した場合は、他方のサイズが計算されます。両方指定したとき、必要サイズに満たない場合はエラーです。1行あたりのバーの数は、c*17+69 となります。

h は、1行あたりのバーの高さを幅の何倍にするかを指定します。仕様では3以上と定められています。それよりも小さい値を指定できますが、そのときの動作は保証されません。

qzx、qzy で指定できる余白（クワイエットゾーン）は、仕様では2以上と定められています。それよりも小さい値を指定できますが、そのときの動作は保証されません。

画像解像度dpi指定は、pngのときのみ有効で、実数値を指定できます。単位は付けられません。

カスタマバーコードは、日本郵便カスタマバーコードや Intelligent Mail® Barcode のようなバーコードです。以下のパラメータを指定できます。

パラメータ	値	既定値	内容
type	JPCBC	必須	日本郵便カスタマバーコード
	IMBC		Intelligent Mail® Barcode
	POSTNET
l	<正数>	後述	ロングバー/フルバーの長さ
t	<正数>	後述	タイミングバー/トラッカバーの長さ
h	<正数>	後述	ハーフバーの長さ（POSTNETのみ）
w	<正数>	後述	バーの幅
p	<正数>	後述	バーのピッチ
hsp	<非負数>	後述	水平方向の余白
vsp	<非負数>	後述	垂直方向の余白
out	svg | png	svg	出力形式
dpi	<正数>	384	pngのときの画像解像度
color	<色>	black	バーコードの色 ☞ color
bgcolor	<色>	white	バーコードの背景色 ☞ color

バーの長さや幅、余白などの値は、単位付きの値でなければなりません。指定できる単位は、pt、pc、in、cm、mm のいずれかです。既定値は以下のとおりです。

パラメータ	JPCBC	IMBC	POSTNET
l	3.6mm	0.15in	0.125in
t	1.2mm	0.05in
h			0.05in
w	0.6mm	0.02in	0.02in
p	1.2mm	0.045in	0.0416in
hsp	2.0mm	0.125in	0
vsp	2.0mm	0.028in	0

pngによる出力では、指定dpiによってバーの長さや幅などがピクセル数に丸められます。そのため、指定の長さと若干異なる出力となることがあります。低解像度を指定したときなどは、バーコードが正しく読み取れない可能性があります。

画像解像度dpi指定は、pngのときのみ有効で、実数値を指定できます。単位は付けられません。

日本郵便カスタマバーコード

Intelligent Mail® Barcode

POSTNET

線形バーコード（一次元バーコード）です。以下のパラメータを指定できます。

パラメータ	値	既定値	内容
type	EAN | JAN	必須
	UPC		UPC-A、UPC-E
	ITF		Interleaved 2of5
	Codabar | NW-7
	Code39
	Code128
	GS1-128 | EAN-128
w	<正数>	0.33mm	細バーの幅
r	<正数>	2.5	太バーの幅の細バーの幅に対する比率 EAN JAN UPC Code128 GS1-128 EAN-128 では不使用
h	<正数>	22.86mm	バーの長さ
qz	<非負数>	10	水平方向の余白（クワイエットゾーン）を細バーの数で指定
scale	<正数>	1	表示倍率
out	svg | png	svg	出力形式
dpi	<正数>	384	pngのときの画像解像度
color	<色>	black	バーコードの色 ☞ color
bgcolor	<色>	white	バーコードの背景色 ☞ color
text	none | auto | center | justify	none	バーコードの下に元コードのテキストをどのように表示するかを指定

バーの長さや幅、余白などの値は、単位付きの値でなければなりません。指定できる単位は、pt、pc、in、cm、mm のいずれかです。

pngによる出力では、指定dpiによってバーの長さや幅などがピクセル数に丸められます。そのため、指定の長さと若干異なる出力となることがあります。低解像度を指定したときなどは、バーコードが正しく読み取れない可能性があります。

画像解像度dpi指定は、pngのときのみ有効で、実数値を指定できます。単位は付けられません。

textの指定によって、バーコードの下に元コードのテキストを表示することができます。ただし、表示形式は代表的なもののみに対応しています。これは、svgによる出力のときのみ有効です。利用するフォントは、オプション設定ファイルのbarcode-text-fontで指定します。文字の大きさは、バーコードの大きさから自動的に計算されます。

• none

  テキストを表示しません。

• auto

  JAN/EAN/UPCでは、一部のバーを引き伸ばし先頭1文字を左に出したりする標準的な出力をします。それ以外ではcenterと扱われます。

• center

  テキストを中央に寄せて表示します。

• justify

  テキストの左右をバーコードの幅にあわせ、均等割り付けして表示します。

EAN / JAN

UPC

Interleaved 2of5

Codabar / NW-7

Code39

Code128

GS1-128 / EAN-128