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

Barcode image generation parameters. More...

Inherits BaseJavaClass.

Public Member Functions

def __init__ (self, javaClass)
 
def init (self)
 
def getUseAntiAlias (self)
 
def setUseAntiAlias (self, value)
 
def getBackColor (self)
 Background color of the barcode image, representation of an RGB tuple. More...
 
def setBackColor (self, value)
 Background color of the barcode image, representation of an RGB tuple. More...
 
def getResolution (self)
 Gets the resolution of the BarCode image. More...
 
def getImage (self)
 
def setResolution (self, value)
 Sets the resolution of the BarCode image. More...
 
def getRotationAngle (self)
 BarCode image rotation angle, measured in degree, e.g. More...
 
def setRotationAngle (self, value)
 BarCode image rotation angle, measured in degree, e.g. More...
 
def getCaptionAbove (self)
 Caption Above the BarCode image. More...
 
def setCaptionAbove (self, value)
 Caption Above the BarCode image. More...
 
def getCaptionBelow (self)
 Caption Below the BarCode image. More...
 
def setCaptionBelow (self, value)
 Caption Below the BarCode image. More...
 
def getAutoSizeMode (self)
 Specifies the different types of automatic sizing modes. More...
 
def setAutoSizeMode (self, value)
 Specifies the different types of automatic sizing modes. More...
 
def getImageHeight (self)
 BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. More...
 
def setImageHeight (self, value)
 BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. More...
 
def getImageWidth (self)
 BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. More...
 
def setImageWidth (self, value)
 BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. More...
 
def getBarcode (self)
 Gets the BarcodeParameters that contains all barcode properties. More...
 
def setBarcode (self, value)
 Gets the BarcodeParameters that contains all barcode properties. More...
 
def getBorder (self)
 Gets the BorderParameters that contains all configuration properties for barcode border. More...
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Public Attributes

 captionAbove
 
 captionBelow
 
 barcodeParameters
 
 borderParameters
 
 imageWidth
 
 imageHeight
 
 image
 
- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

Barcode image generation parameters.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ getAutoSizeMode()

def getAutoSizeMode (   self)

Specifies the different types of automatic sizing modes.

Default value: AutoSizeMode.NONE.

◆ getBackColor()

def getBackColor (   self)

Background color of the barcode image, representation of an RGB tuple.

Default value: 0

◆ getBarcode()

def getBarcode (   self)

Gets the BarcodeParameters that contains all barcode properties.

◆ getBorder()

def getBorder (   self)

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

◆ getCaptionAbove()

def getCaptionAbove (   self)

Caption Above the BarCode image.

See CaptionParameters.

◆ getCaptionBelow()

def getCaptionBelow (   self)

Caption Below the BarCode image.

See CaptionParameters.

◆ getImage()

def getImage (   self)
Image parameters. See ImageParameters
:return:

◆ getImageHeight()

def getImageHeight (   self)

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

◆ getImageWidth()

def getImageWidth (   self)

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

◆ getResolution()

def getResolution (   self)

Gets the resolution of the BarCode image.

One value for both dimensions. Default value: 96 dpi. The Resolution parameter value is less than or equal to 0.

◆ getRotationAngle()

def getRotationAngle (   self)

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

◆ getUseAntiAlias()

def getUseAntiAlias (   self)
Gets a value indicating whether is used anti-aliasing mode to render image

◆ init()

def init (   self)

Reimplemented from BaseJavaClass.

◆ setAutoSizeMode()

def setAutoSizeMode (   self,
  value 
)

Specifies the different types of automatic sizing modes.

Default value: AutoSizeMode.NONE.

◆ setBackColor()

def setBackColor (   self,
  value 
)

Background color of the barcode image, representation of an RGB tuple.

Default value: 0

◆ setBarcode()

def setBarcode (   self,
  value 
)

Gets the BarcodeParameters that contains all barcode properties.

◆ setCaptionAbove()

def setCaptionAbove (   self,
  value 
)

Caption Above the BarCode image.

See CaptionParameters.

◆ setCaptionBelow()

def setCaptionBelow (   self,
  value 
)

Caption Below the BarCode image.

See CaptionParameters.

◆ setImageHeight()

def setImageHeight (   self,
  value 
)

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

◆ setImageWidth()

def setImageWidth (   self,
  value 
)

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

◆ setResolution()

def setResolution (   self,
  value 
)

Sets the resolution of the BarCode image.

One value for both dimensions. Default value: 96 dpi. The Resolution parameter value is less than or equal to 0.

◆ setRotationAngle()

def setRotationAngle (   self,
  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 = BarcodeGenerator( EncodeTypes.DATA_MATRIX)
generator.getParameters().setRotationAngle(7)
generator.save("test.png")

◆ setUseAntiAlias()

def setUseAntiAlias (   self,
  value 
)
Sets a value indicating whether is used anti-aliasing mode to render image

Member Data Documentation

◆ barcodeParameters

barcodeParameters

◆ borderParameters

borderParameters

◆ captionAbove

captionAbove

◆ captionBelow

captionBelow

◆ image

image

◆ imageHeight

imageHeight

◆ imageWidth

imageWidth