gcbc:GcBarcodeコンポーネント

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

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

属性名 属性型 説明
imageHeight Integer バーコード画像の高さをピクセル単位で指定します。実際に生成されるバーコードの画像の高さは、type属性で指定したバーコードの規格に基づいてimageHeightに近い値になります。既定値は100ピクセルです。
imageWidth Integer バーコード画像の幅をピクセル単位で指定します。実際に生成されるバーコードの画像の幅は、type属性で指定したバーコードの規格に基づいてimageWidthに近い値になります。既定値は100ピクセルです。
outputFormat String バーコード画像の形式を指定します。「PNG」または「SVG」を指定できます。既定値は「SVG」です。この値は大文字で指定します。
options String バーコードタイプ固有の追加オプションを指定します。「バーコードのオプション」を参照してください。
type String 生成するバーコードの種類を指定します。「バーコードの種類」を参照してください。既定値は「QRCode」です。 
valueString String 必須項目。バーコードの値を設定します。Lightningアプリでは値をURLエンコードする必要はありません。

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

イベント名 イベント型 説明
onError gcbc:GcBarcodeError エラー処理を行う関数を指定します。詳細は後述の「エラー処理」を参照してください。

エンコーディング形式

RayBarcodeでは既定のエンコーディング形式にShift-JIS(シフトJIS)を使用します。UTF-8を使用する場合はオプションを指定する必要があります。

Lightningアプリケーションビルダーの場合、次の値を「options」に設定します。

{'EncodingCodePage':'65001'}

開発者コンソールの場合、次のようになります。

<gcbc:GcBarcode
    valueString="490210200005"
    type="QRCode"
    options='{"EncodingCodePage":"65001"}'
    imageWidth="200"
    imageHeight="100"
    outputFormat="PNG"
    />

エラー処理

エラーが発生した場合、GcBarcodeコンポーネントで onError イベントが発生します。 onError イベントでは、エラーメッセージを取得できます。

既定では、エラーがサーバー側で発生した場合、回復できないエラーとなります。その場合、以下のようなAuraのエラーメッセージが表示されます。

このようなエラーが発生する場合、以下の解決方法を試してみてください。

  • ブラウザでWebページの「再読み込み」または「更新」を実行する
  • ブラウザをシークレットモードで実行する。またはInPrivateモードで実行する。
  • Salesforceからログアウトし、再度ログインする
  • Salesforceアプリの場合、アプリのプロセスを終了し、もう1度起動する

開発者は、すべてのエラーを処理するためにコードを記述でき、必要に応じて既定のエラーメッセージを表示しないこともできます。

コードは以下のとおりです。

// エラーイベントを処理する
<aura:component implements="force:appHostable,flexipage:availableForAllPageTypes,flexipage:availableForRecordHome,force:hasRecordId,forceCommunity:availableForAllPageTypes" access="global" >
    <gcbc:GcBarcode type="JAN13" valueString="Barcode Value" imageWidth="200" imageHeight="200" onError="{!c.HandleError}" />
</aura:component>

// エラー処理を行う
({
    HandleError : function(component, event, helper){   
        var message = event.getParam("message");
        alert(message);
        event.setParam("handled", true);
    }
})

リファレンス(英語)

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.