BarcodeParameters

BarcodeParameters class

Module: aspose_barcode.generation.barcode_parameters

Barcode generation parameters.

Constructors

Name	Description
init

Methods

Name	Return Type	Static	Description
australian_post	`AustralianPostParameters`	No	AustralianPost barcode parameters.
aztec	`AztecParameters`	No	Aztec parameters.
codabar	`CodabarParameters`	No	Codabar parameters.
codablock	`CodablockParameters`	No	Codablock parameters.
code_128	`Code128Parameters`	No	Code128 parameters.
code_16k	`Code16KParameters`	No	Code16K parameters.
codetext_parameters	`CodetextParameters`	No	Codetext parameters.
coupon	`CouponParameters`	No	Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.
data_bar	`DataBarParameters`	No	Databar parameters.
data_matrix	`DataMatrixParameters`	No	DataMatrix parameters.
dot_code	`DotCodeParameters`	No	DotCode parameters.
han_xin	`HanXinParameters`	No	HanXin parameters.
itf	`ITFParameters`	No	ITF parameters.
maxi_code	`MaxiCodeParameters`	No	MaxiCode parameters.
padding	`Padding`	No	Barcode paddings. Default value: 5pt 5pt 5pt 5pt.
patch_code	`PatchCodeParameters`	No	PatchCode parameters.
pdf_417	`Pdf417Parameters`	No	PDF417 parameters.
postal	`PostalParameters`	No	Postal parameters. Used for Postnet, Planet.
qr	`QrParameters`	No	QR parameters.
supplement	`SupplementParameters`	No	Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.

Properties

Name	Type	Description
bar_color	`Tuple[int, int, int]`	Bars color, representation of an RGB tuple. Default value: 0
bar_height	`Unit`	Height of 1D barcodes’ bars in Unit value. Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
bar_width_reduction	`Unit`	Get bars reduction value that is used to compensate ink spread while printing.
checksum_always_show	`bool`	Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
checksum_enabled	`EnableChecksum`	Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology
enable_escape	`bool`	Indicates whether explains the character “" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is True, “" will be explained as a special escape character. Otherwise, “" acts as normal characters. Aspose.BarCode supports inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \CR stands for CR.
filled_bars	`bool`	Gets a value indicating whether bars filled. Only for 1D barcodes. Default value: True.
gs1_composite_bar	`GS1CompositeBarParameters`	GS1 Composite Bar parameters. This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol ‘/’
wide_narrow_ratio	`float`	Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard The WideNarrowRatio parameter value is less than or equal to 0.
x_dimension	`Unit`	x-dimension is the smallest width of the unit of BarCode bars or spaces. Increasing this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

BarcodeParameters Constructor

__init__(self, java_class) -> def

Parameter	Type	Description
`java_class`	``

BarcodeParameters.australian_post

australian_post(self) -> AustralianPostParameters

AustralianPost barcode parameters.

Return Type: AustralianPostParameters

BarcodeParameters.aztec

aztec(self) -> AztecParameters

Aztec parameters.

Return Type: AztecParameters

BarcodeParameters.codabar

codabar(self) -> CodabarParameters

Codabar parameters.

Return Type: CodabarParameters

BarcodeParameters.codablock

codablock(self) -> CodablockParameters

Codablock parameters.

Return Type: CodablockParameters

BarcodeParameters.code_128

code_128(self) -> Code128Parameters

Code128 parameters.

Return Type: Code128Parameters

BarcodeParameters.code_16k

code_16k(self) -> Code16KParameters

Code16K parameters.

Return Type: Code16KParameters

BarcodeParameters.codetext_parameters

codetext_parameters(self) -> CodetextParameters

Codetext parameters.

Return Type: CodetextParameters

BarcodeParameters.coupon

coupon(self) -> CouponParameters

Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.

Return Type: CouponParameters

BarcodeParameters.data_bar

data_bar(self) -> DataBarParameters

Databar parameters.

Return Type: DataBarParameters

BarcodeParameters.data_matrix

data_matrix(self) -> DataMatrixParameters

DataMatrix parameters.

Return Type: DataMatrixParameters

BarcodeParameters.dot_code

dot_code(self) -> DotCodeParameters

DotCode parameters.

Return Type: DotCodeParameters

BarcodeParameters.han_xin

han_xin(self) -> HanXinParameters

HanXin parameters.

Return Type: HanXinParameters

BarcodeParameters.itf

itf(self) -> ITFParameters

ITF parameters.

Return Type: ITFParameters

BarcodeParameters.maxi_code

maxi_code(self) -> MaxiCodeParameters

MaxiCode parameters.

Return Type: MaxiCodeParameters

BarcodeParameters.padding

padding(self) -> Padding

Barcode paddings. Default value: 5pt 5pt 5pt 5pt.

Return Type: Padding

BarcodeParameters.patch_code

patch_code(self) -> PatchCodeParameters

PatchCode parameters.

Return Type: PatchCodeParameters

BarcodeParameters.pdf_417

pdf_417(self) -> Pdf417Parameters

PDF417 parameters.

Return Type: Pdf417Parameters

BarcodeParameters.postal

postal(self) -> PostalParameters

Postal parameters. Used for Postnet, Planet.

Return Type: PostalParameters

BarcodeParameters.qr

qr(self) -> QrParameters

QR parameters.

Return Type: QrParameters

BarcodeParameters.supplement

supplement(self) -> SupplementParameters

Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.

Return Type: SupplementParameters

BarcodeParameters.bar_color

Type: Tuple[int, int, int]

Bars color, representation of an RGB tuple. Default value: 0

Bars color, representation of an RGB tuple. Default value: 0.

Parameter	Type	Description
`value`	`Tuple[int, int, int]`

BarcodeParameters.bar_height

Type: Unit

Height of 1D barcodes’ bars in Unit value. Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

Parameter	Type	Description
`value`	`Unit`

BarcodeParameters.bar_width_reduction

Type: Unit

Get bars reduction value that is used to compensate ink spread while printing.

Returns: Unit value of BarWidthReduction

Sets bars reduction value that is used to compensate ink spread while printing.

Parameter	Type	Description
`value`	`Unit`

BarcodeParameters.checksum_always_show

Type: bool

Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.

Always display checksum digit in the human-readable text for Code128 and GS1Code128 barcodes.

Parameter	Type	Description
`value`	`bool`

BarcodeParameters.checksum_enabled

Type: EnableChecksum

Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology

Parameter	Type	Description
`value`	`EnableChecksum`

BarcodeParameters.enable_escape

Type: bool

Indicates whether explains the character “" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is True, “" will be explained as a special escape character. Otherwise, “" acts as normal characters. Aspose.BarCode supports inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \CR stands for CR.

Parameter	Type	Description
`value`	`bool`

BarcodeParameters.filled_bars

Type: bool

Gets a value indicating whether bars filled. Only for 1D barcodes. Default value: True.

Sets a value indicating whether bars filled. Only for 1D barcodes. Default value: True.

Parameter	Type	Description
`value`	`bool`

BarcodeParameters.gs1_composite_bar

Type: GS1CompositeBarParameters

GS1 Composite Bar parameters. This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol ‘/’

Returns: GS1CompositeBarParameters GS1 Composite Bar parameters.

GS1 Composite Bar parameters. This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol ‘/’

Parameter	Type	Description
`value`	`GS1CompositeBarParameters`

BarcodeParameters.wide_narrow_ratio

Type: float

Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard The WideNarrowRatio parameter value is less than or equal to 0.

Parameter	Type	Description
`value`	`float`

BarcodeParameters.x_dimension

Type: Unit

x-dimension is the smallest width of the unit of BarCode bars or spaces. Increasing this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

Parameter	Type	Description
`unit`	`Unit`