Skip to content

Latest commit

 

History

History
64 lines (60 loc) · 8.01 KB

GeneratorParams.md

File metadata and controls

64 lines (60 loc) · 8.01 KB
Raw

GeneratorParams

Properties

Name Type Description Notes
type_of_barcode EncodeBarcodeType Type of barcode to generate.
text str Text to encode.
two_d_display_text str Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode [optional]
text_location CodeLocation Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. [optional]
text_alignment TextAlignment Text alignment. [optional]
text_color str Specify the displaying CodeText's Color. Default value: Color.Black. [optional]
font FontParams Specify the displaying Text's font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto. [optional]
font_size_mode FontMode Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. [optional]
no_wrap bool Specify word wraps (line breaks) within text. Default value: False. [optional]
resolution float Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. [optional]
resolution_x float DEPRECATED: Use 'Resolution' instead. [optional]
resolution_y float DEPRECATED: Use 'Resolution' instead. [optional]
dimension_x float The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation. [optional]
text_space float Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon. [optional]
units AvailableGraphicsUnit Common Units for all measuring in query. Default units: pixel. [optional]
size_mode AutoSizeMode Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None. [optional]
bar_height float Height of the barcode in given units. Default units: pixel. [optional]
image_height float Height of the barcode image in given units. Default units: pixel. [optional]
image_width float Width of the barcode image in given units. Default units: pixel. [optional]
rotation_angle 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. [optional]
padding Padding Barcode paddings. Default value: 5pt 5pt 5pt 5pt. [optional]
caption_above CaptionParams Additional caption above barcode. [optional]
caption_below CaptionParams Additional caption below barcode. [optional]
back_color str Background color of the barcode image. Default value: Color.White. [optional]
bar_color str Bars color. Default value: Color.Black. [optional]
border_color str Border color. Default value: Color.Black. [optional]
border_width float Border width. Default value: 0. Ignored if Visible is set to False. [optional]
border_dash_style BorderDashStyle Border dash style. Default value: BorderDashStyle.Solid. [optional]
border_visible bool Border visibility. If False than parameter Width is always ignored (0). Default value: False. [optional]
enable_checksum 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 [optional]
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 input decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR. [optional]
filled_bars bool Value indicating whether bars are filled. Only for 1D barcodes. Default value: True. [optional]
always_show_checksum bool Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. [optional]
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 [optional]
validate_text bool Only for 1D barcodes. If codetext is incorrect and value set to True - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect. [optional]
supplement_data str Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN. [optional]
supplement_space float Space between main the BarCode and supplement BarCode. [optional]
bar_width_reduction float Bars reduction value that is used to compensate ink spread while printing. [optional]
use_anti_alias bool Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing. [optional]
australian_post AustralianPostParams AustralianPost params. [optional]
aztec AztecParams Aztec params. [optional]
codabar CodabarParams Codabar params. [optional]
codablock CodablockParams Codablock params. [optional]
code16_k Code16KParams Code16K params. [optional]
coupon CouponParams Coupon params. [optional]
data_bar DataBarParams DataBar params. [optional]
data_matrix DataMatrixParams DataMatrix params. [optional]
dot_code DotCodeParams DotCode params. [optional]
itf ITFParams ITF params. [optional]
maxi_code MaxiCodeParams MaxiCode params. [optional]
pdf417 Pdf417Params Pdf417 params. [optional]
postal PostalParams Postal params. [optional]
qr QrParams QR params. [optional]
patch_code PatchCodeParams PatchCode params. [optional]
code128 Code128Params Code128 params. [optional]

[Back to Model list] [Back to API list] [Back to README]