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

Inherits BaseJavaClass.

Public Member Functions

 getBackColor ()
 
 setBackColor ($hexValue)
 
 getResolution ()
 
 setResolution ($value)
 
 getRotationAngle ()
 
 setRotationAngle ($value)
 
 getCaptionAbove ()
 
 setCaptionAbove (CaptionParameters $value)
 
 getCaptionBelow ()
 
 setCaptionBelow (CaptionParameters $value)
 
 getAutoSizeMode ()
 
 setAutoSizeMode ($value)
 
 getImageHeight ()
 
 setImageHeight (Unit $value)
 
 getImageWidth ()
 
 setImageWidth (Unit $value)
 
 getBarcode ()
 
 setBarcode (BarcodeParameters $value)
 
 getBorder ()
 

Detailed Description

Barcode image generation parameters.

Member Function Documentation

◆ getAutoSizeMode()

getAutoSizeMode ( )

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

◆ getBackColor()

getBackColor ( )

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

◆ getBarcode()

getBarcode ( )

Gets the BarcodeParameters that contains all barcode properties.

◆ getBorder()

getBorder ( )

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

◆ getCaptionAbove()

getCaptionAbove ( )

Caption Above the BarCode image. See CaptionParameters.

◆ getCaptionBelow()

getCaptionBelow ( )

Caption Below the BarCode image. See CaptionParameters.

◆ getImageHeight()

getImageHeight ( )

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

◆ getImageWidth()

getImageWidth ( )

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

◆ getResolution()

getResolution ( )

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

Exceptions
IllegalArgumentExceptionThe Resolution parameter value is less than or equal to 0.

◆ getRotationAngle()

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 = new BarcodeGenerator( EncodeTypes::DATA_MATRIX);
    $generator->getParameters()->setRotationAngle(7);
    $generator->save("test.png");
   

◆ setAutoSizeMode()

setAutoSizeMode (   $value)

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

◆ setBackColor()

setBackColor (   $hexValue)

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

◆ setBarcode()

setBarcode ( BarcodeParameters  $value)

Gets the BarcodeParameters that contains all barcode properties.

◆ setCaptionAbove()

setCaptionAbove ( CaptionParameters  $value)

Caption Above the BarCode image. See CaptionParameters.

◆ setCaptionBelow()

setCaptionBelow ( CaptionParameters  $value)

Caption Below the BarCode image. See CaptionParameters.

◆ setImageHeight()

setImageHeight ( Unit  $value)

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

◆ setImageWidth()

setImageWidth ( Unit  $value)

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

◆ setResolution()

setResolution (   $value)

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

Exceptions
IllegalArgumentExceptionThe Resolution parameter value is less than or equal to 0.

◆ setRotationAngle()

setRotationAngle (   $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 = new BarcodeGenerator( EncodeTypes::DATA_MATRIX);
    $generator->getParameters()->setRotationAngle(7);
    $generator->save("test.png");