BaseGenerationParameters

BaseGenerationParameters class

Module: aspose_barcode.generation.base_generation_parameters

Barcode image generation parameters.

Constructors

NameDescription
init

Methods

NameReturn TypeStaticDescription
barcodeBarcodeParametersNoGets the BarcodeParameters that contains all barcode properties.
borderBorderParametersNoGets the BorderParameters that contains all configuration properties for barcode border.
caption_aboveCaptionParametersNoCaption Above the BarCode image. See CaptionParameters.
caption_belowCaptionParametersNoCaption Below the BarCode image. See CaptionParameters.
imageImageParametersNo

Properties

NameTypeDescription
auto_size_modeAutoSizeModeSpecifies the different types of automatic sizing modes. Default value: AutoSizeMode.NONE.
back_colorTuple[int, int, int]
image_heightUnitBarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
image_widthUnitBarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
resolutionfloatGets 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.
rotation_anglefloatBarCode 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.
use_anti_aliasbool

BaseGenerationParameters Constructor

__init__(self, _java_class) -> def
ParameterTypeDescription
_java_class``

BaseGenerationParameters.barcode

barcode(self) -> BarcodeParameters

Gets the BarcodeParameters that contains all barcode properties.

Return Type: BarcodeParameters

BaseGenerationParameters.border

border(self) -> BorderParameters

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

Return Type: BorderParameters

BaseGenerationParameters.caption_above

caption_above(self) -> CaptionParameters

Caption Above the BarCode image. See CaptionParameters.

Return Type: CaptionParameters

BaseGenerationParameters.caption_below

caption_below(self) -> CaptionParameters

Caption Below the BarCode image. See CaptionParameters.

Return Type: CaptionParameters

BaseGenerationParameters.image

image(self) -> ImageParameters

Return Type: ImageParameters

BaseGenerationParameters.auto_size_mode

Type: AutoSizeMode

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

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

ParameterTypeDescription
valueAutoSizeMode

BaseGenerationParameters.back_color

Type: Tuple[int, int, int]

ParameterTypeDescription
valueTuple[int, int, int]

BaseGenerationParameters.image_height

Type: Unit

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

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

ParameterTypeDescription
valueUnit

BaseGenerationParameters.image_width

Type: Unit

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

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

ParameterTypeDescription
valueUnit

BaseGenerationParameters.resolution

Type: float

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.

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.

ParameterTypeDescription
valuefloat

BaseGenerationParameters.rotation_angle

Type: float

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.

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.

ParameterTypeDescription
valuefloat

BaseGenerationParameters.use_anti_alias

Type: bool

ParameterTypeDescription
valuebool