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

Barcode image generation parameters. More...

Inherits asposebarcode.Assist.BaseJavaClass.

Public Member Functions

def __init__ (self, javaClass)
 
def init (self)
 
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 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 asposebarcode.Assist.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
 
- Public Attributes inherited from asposebarcode.Assist.BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

Barcode image generation parameters.

Constructor & Destructor Documentation

◆ __init__()

def asposebarcode.Generation.BaseGenerationParameters.__init__ (   self,
  javaClass 
)

Member Function Documentation

◆ getAutoSizeMode()

def asposebarcode.Generation.BaseGenerationParameters.getAutoSizeMode (   self)

Specifies the different types of automatic sizing modes.

Default value: AutoSizeMode.NONE.

◆ getBackColor()

def asposebarcode.Generation.BaseGenerationParameters.getBackColor (   self)

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

Default value: 0

◆ getBarcode()

def asposebarcode.Generation.BaseGenerationParameters.getBarcode (   self)

Gets the BarcodeParameters that contains all barcode properties.

◆ getBorder()

def asposebarcode.Generation.BaseGenerationParameters.getBorder (   self)

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

◆ getCaptionAbove()

def asposebarcode.Generation.BaseGenerationParameters.getCaptionAbove (   self)

Caption Above the BarCode image.

See CaptionParameters.

◆ getCaptionBelow()

def asposebarcode.Generation.BaseGenerationParameters.getCaptionBelow (   self)

Caption Below the BarCode image.

See CaptionParameters.

◆ getImageHeight()

def asposebarcode.Generation.BaseGenerationParameters.getImageHeight (   self)

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

◆ getImageWidth()

def asposebarcode.Generation.BaseGenerationParameters.getImageWidth (   self)

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

◆ getResolution()

def asposebarcode.Generation.BaseGenerationParameters.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 asposebarcode.Generation.BaseGenerationParameters.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")

◆ init()

def asposebarcode.Generation.BaseGenerationParameters.init (   self)

◆ setAutoSizeMode()

def asposebarcode.Generation.BaseGenerationParameters.setAutoSizeMode (   self,
  value 
)

Specifies the different types of automatic sizing modes.

Default value: AutoSizeMode.NONE.

◆ setBackColor()

def asposebarcode.Generation.BaseGenerationParameters.setBackColor (   self,
  value 
)

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

Default value: 0

◆ setBarcode()

def asposebarcode.Generation.BaseGenerationParameters.setBarcode (   self,
  value 
)

Gets the BarcodeParameters that contains all barcode properties.

◆ setCaptionAbove()

def asposebarcode.Generation.BaseGenerationParameters.setCaptionAbove (   self,
  value 
)

Caption Above the BarCode image.

See CaptionParameters.

◆ setCaptionBelow()

def asposebarcode.Generation.BaseGenerationParameters.setCaptionBelow (   self,
  value 
)

Caption Below the BarCode image.

See CaptionParameters.

◆ setImageHeight()

def asposebarcode.Generation.BaseGenerationParameters.setImageHeight (   self,
  value 
)

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

◆ setImageWidth()

def asposebarcode.Generation.BaseGenerationParameters.setImageWidth (   self,
  value 
)

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

◆ setResolution()

def asposebarcode.Generation.BaseGenerationParameters.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 asposebarcode.Generation.BaseGenerationParameters.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")

Member Data Documentation

◆ barcodeParameters

asposebarcode.Generation.BaseGenerationParameters.barcodeParameters

◆ borderParameters

asposebarcode.Generation.BaseGenerationParameters.borderParameters

◆ captionAbove

asposebarcode.Generation.BaseGenerationParameters.captionAbove

◆ captionBelow

asposebarcode.Generation.BaseGenerationParameters.captionBelow

◆ imageHeight

asposebarcode.Generation.BaseGenerationParameters.imageHeight

◆ imageWidth

asposebarcode.Generation.BaseGenerationParameters.imageWidth