gcbc:GcBarcodeScannerLTコンポーネント

gcbc:GcBarcodeScannerLTコンポーネントについて説明します。

gcbc:GcBarcodeScannerLTコンポーネントの属性

gcbc:GcBarcodeScannerLTは、独自の読み取り開始ボタンを持つLightningアプリケーションを開発する際使用するコンポーネントです。

barcodeFormatuseFrontCameraIfAvailableはGrapeCity Barcode v3で新たに追加された属性です。

属性名 属性型 説明
title String 画面の上部に表示されるタイトルを指定します。文字列は中央寄せで表示されます。表示される文字列は、画面の端で自動改行されます。文字数制限はないですが、表示領域からはみ出してしまった文字列は省略されます。また、改行(\r\n)・タブ・スペースの入力が可能です。ただし、文字列の先頭と末尾の空白文字(タブやスペースなど)を取り除きます。既定値は空白です。
font-color String タイトルのフォント色を指定します。デフォルト色は白です。属性値は大文字と小文字を区別しません。指定可能な色についてはこちらのリンクの「Fields」欄を参照してください。 例)font-color=“Aquamarine”
font-size Number タイトルのフォントサイズを指定します。既定値は16です。 例)font-size=“20”
background-color String 余白エリアの背景色を指定します。デフォルト色は黒です。属性値は大文字と小文字を区別しません。指定可能な色についてはこちらのリンクの「Fields」欄を参照してください。 例)background-color=“Blue”
opacity Number 余白エリアの透明度を調整します。既定値は0.7です。指定可能な値の範囲は0~1です。0だと完全透明、1だと不透明となります。 例)opacity=“0.3”
barcodeFormat string スキャナが認識するバーコード形式を指定します。バーコードの種類の値は、読み取るバーコードの種類を参照してください。複数の種類のバーコードを読み取る場合は、バーコード形式をコンマ(,)で区切ります。既定ではすべてのバーコード形式が認識対象です。
buttonText string 読み取りボタンのキャプションを取得または設定します。たとえば「読み取り開始」と指定します。
class string コンポーネントに適用されるCSSスタイル。 このスタイルは、コンポーネントによって出力される基本スタイルに追加されます。
continuousScan boolean エンドユーザが読み取り画面を終了するか、連続読み取りのコールバックサービスが読み取り終了を返すまで、RayBarcode Readerアプリが連続読み取りを実行するかどうかを指定します。既定値はfalseです。
continuousScanCallback string 連続読み取りを制御するためのWebServiceのコールバック。コールバックの詳細はWebServiceを使った連続読み取り機能の開発で説明します。
scanResults string 読み取り結果。読み取り結果が複数の場合はコンマ(,)で区切られます。
scannedTypes string 読み取ったバーコードの種類。読み取り結果が複数の場合はコンマ(,)で区切られます。バーコードの種類の値は、読み取るバーコードの種類を参照してください。
useFrontCameraIfAvailable boolean フロントカメラ(インカメラ)を使用するかどうかを指定します。trueのときフロントカメラを使用します。falseのときフロントカメラを使用しません。既定値はfalseです。フロントカメラが利用可能でない場合はバックカメラ(リアカメラ、背面カメラ)を使用します。フロントカメラはQRコードのみの対応です。QRコード以外の対応はベータ扱いです。

gcbc:GcBarcodeScannerLTコンポーネントのイベント

イベント名 イベント型 説明
onScanComplete gcbc:GcBarcodeScanFinish 読み取りが完了したときのイベントです。

gcbc:GcBarcodeScannerLTコンポーネントのメソッド

v3.2より以前のバージョンで利用可能だったscanメソッドが使用できなくなります。 v3.2より以前のバージョンでscanメソッドを直接呼び出している箇所がありましたら、その部分を削除またはコメントアウトすることで今までの通り読み取り機能を利用することができます。

リファレンス(英語)

Aura DocumentationでLightningコンポーネントの属性の完全なリストと英語のリファレンスを参照できます。

Aura Documentationは、以下のURLでアクセスできます。

https://[YOUR INSTANCE or CUSTOMDOMAIN].lightning.force.com/docs/component-library/bundle/gcbc:GcBarcode/documentation

たとえば、Lightning Experienceに切り替えた画面でブラウザのアドレスバーのURLが「ap0.lightning.force.com」で始まる場合、Aura DocumentのURLは次のようになります。

https://ap0.lightning.force.com/docs/component-library/bundle/gcbc:GcBarcode/documentation
Copyright © 2020 GrapeCity inc. All rights reserved.