Aspose.Barcode for PHP via Java Generation and Recognition API docs

Inherits BaseJavaClass.

Public Member Functions

 getBackColor ()
 
 setBackColor (string $hexValue)
 
 getResolution ()
 
 setResolution (float $value)
 
 getRotationAngle ()
 
 setRotationAngle (float $value)
 
 getCaptionAbove ()
 
 setCaptionAbove (CaptionParameters $value)
 
 getCaptionBelow ()
 
 setCaptionBelow (CaptionParameters $value)
 
 getAutoSizeMode ()
 
 setAutoSizeMode (int $value)
 
 getImageHeight ()
 
 setImageHeight (Unit $value)
 
 getImageWidth ()
 
 setImageWidth (Unit $value)
 
 getBarcode ()
 
 setBarcode (BarcodeParameters $value)
 
 getBorder ()
 
- Public Member Functions inherited from BaseJavaClass
 __construct ($javaClass)
 
 getJavaClass ()
 
 getJavaClassName ()
 
 isNull ()
 
 printJavaClassName ()
 

Protected Member Functions

 init ()
 
- Protected Member Functions inherited from BaseJavaClass
 setJavaClass ($javaClass)
 

Private Attributes

 $captionAbove
 
 $captionBelow
 
 $barcodeParameters
 
 $borderParameters
 
 $imageWidth
 
 $imageHeight
 

Detailed Description

Barcode image generation parameters.

Member Function Documentation

◆ getAutoSizeMode()

BaseGenerationParameters::getAutoSizeMode ( )

Specifies the different types of automatic sizing modes. Default value: AutoSizeMode::NONE.

◆ getBackColor()

BaseGenerationParameters::getBackColor ( )

Background color of the barcode image. Default value: #FFFFFF

Returns
string value of background color.

◆ getBarcode()

BaseGenerationParameters::getBarcode ( )

Gets the BarcodeParameters that contains all barcode properties.

◆ getBorder()

BaseGenerationParameters::getBorder ( )

Gets the BorderParameters that contains all configuration properties for barcode border.

◆ getCaptionAbove()

BaseGenerationParameters::getCaptionAbove ( )

Caption Above the BarCode image.

See also
CaptionParameters.

◆ getCaptionBelow()

BaseGenerationParameters::getCaptionBelow ( )

Caption Below the BarCode image.

See also
CaptionParameters.

◆ getImageHeight()

BaseGenerationParameters::getImageHeight ( )

BarCode image height when AutoSizeMode property is set to AutoSizeMode::NEAREST or AutoSizeMode::INTERPOLATION.

◆ getImageWidth()

BaseGenerationParameters::getImageWidth ( )

BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode::INTERPOLATION.

◆ getResolution()

BaseGenerationParameters::getResolution ( )

Gets the resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.

Returns
float The Resolution parameter value is less than or equal to 0.
Exceptions
BarcodeException

◆ getRotationAngle()

BaseGenerationParameters::getRotationAngle ( )

BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.

This sample shows how to create and save a BarCode image.

$generator->getParameters()->setRotationAngle(7);
$generator->save("test.png");

◆ init()

BaseGenerationParameters::init ( )
protected

Reimplemented from BaseJavaClass.

◆ setAutoSizeMode()

BaseGenerationParameters::setAutoSizeMode ( int  $value)

Specifies the different types of automatic sizing modes. Default value: AutoSizeMode::NONE.

◆ setBackColor()

BaseGenerationParameters::setBackColor ( string  $hexValue)

Background color of the barcode image. Default value: #FFFFFF

Parameters
string$hexValuevalue of background color.
Exceptions
BarcodeException

◆ setBarcode()

BaseGenerationParameters::setBarcode ( BarcodeParameters  $value)

Gets the BarcodeParameters that contains all barcode properties.

◆ setCaptionAbove()

BaseGenerationParameters::setCaptionAbove ( CaptionParameters  $value)

Caption Above the BarCode image.

See also
CaptionParameters.

◆ setCaptionBelow()

BaseGenerationParameters::setCaptionBelow ( CaptionParameters  $value)

Caption Below the BarCode image.

See also
CaptionParameters.

◆ setImageHeight()

BaseGenerationParameters::setImageHeight ( Unit  $value)

BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode::INTERPOLATION.

◆ setImageWidth()

BaseGenerationParameters::setImageWidth ( Unit  $value)

BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode::INTERPOLATION.

◆ setResolution()

BaseGenerationParameters::setResolution ( float  $value)

Sets the resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.

Parameters
float$valueThe Resolution parameter value is less than or equal to 0.
Exceptions
BarcodeException

◆ setRotationAngle()

BaseGenerationParameters::setRotationAngle ( float  $value)

BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.

This sample shows how to create and save a BarCode image.

$generator->getParameters()->setRotationAngle(7);
$generator->save("test.png");

Member Data Documentation

◆ $barcodeParameters

BaseGenerationParameters::$barcodeParameters
private

◆ $borderParameters

BaseGenerationParameters::$borderParameters
private

◆ $captionAbove

BaseGenerationParameters::$captionAbove
private

◆ $captionBelow

BaseGenerationParameters::$captionBelow
private

◆ $imageHeight

BaseGenerationParameters::$imageHeight
private

◆ $imageWidth

BaseGenerationParameters::$imageWidth
private