Documentation – Generate barcodes

V4: Set Barcode Text

Mon, 01 Jan 0001 00:00:00 +0000

This documentation covers how to set barcode text in the Aspose.BarCode Cloud SDK for Swift. The Barcode API supports multiple methods to generate barcodes in different formats using GET and POST requests through the GenerateAPI. Barcodes can be generated by specifying various parameters such as barcode type, data to encode, image format and display options. The data encoding process involves defining the type of data and the actual content.

GenerateAPI

The GenerateAPI interface includes methods for generating barcodes:

GET Request: Uses parameters in the URL route and query string.
POST Request (JSON/XML): Parameters are provided in the request body.
POST Request (Multipart Form): Parameters are sent as URL-encoded form data.

Methods

generate: Generates a barcode via GET request.
generateBody: Generates a barcode via POST request with JSON or XML body.
generateMultipart: Generates a barcode via POST request with multipart form data.

Setting Barcode Text

Properties

dataType: Specifies the type of data encoding (can be string, base64, or hex). If not set, the data value is used as plain text.
data: A string that represents the data to be encoded.

Supported Data Types

Value	Description
.stringData (Default value)	Plain text
.base64Bytes	Base64 encoded binary data
.hexBytes	Hexadecimal encoded binary data

Barcode Generation Example

Below are examples to demonstrate barcode generation using the GenerateAPI methods.

Example 1: Generating a Barcode with GET Request

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generate(
    barcodeType: .qr,
    data: "Aspose.BarCode.Cloud",
    dataType: .stringData,
    barcodeImageParams: BarcodeImageParams(imageFormat: .png),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "qr.png"))
print("File 'qr.png' generated.")

Result Image is:

Example 2: Generating a Barcode with POST Request (JSON Body)

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let encodedText = Data("Aspose.BarCode.Cloud".utf8).base64EncodedString()
let generateParams = GenerateParams(
    barcodeType: .qr,
    encodeData: EncodeData(dataType: .base64Bytes, data: encodedText),
    barcodeImageParams: BarcodeImageParams(imageFormat: .png)
)

let imageData = try await GenerateAPI.generateBody(
    generateParams: generateParams,
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "qr.png"))
print("File 'qr.png' generated.")

Result Image is:

Example 3: Generating a Barcode with POST Request (Multipart Form)

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let hexText = "4173706F73652E426172436F64652E436C6F7564"
let imageData = try await GenerateAPI.generateMultipart(
    barcodeType: .qr,
    data: hexText,
    dataType: .hexBytes,
    barcodeImageParams: BarcodeImageParams(imageFormat: .png),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "qr.png"))
print("File 'qr.png' generated.")

Result Image is:

This documentation covers how to use the GenerateAPI to set barcodes text.

V4: Set Barcode Size

Mon, 01 Jan 0001 00:00:00 +0000

This documentation provides a guide on how to set barcode sizes using in the Aspose.BarCode Cloud SDK for Swift. This guide includes examples and descriptions for configuring the height, width, and resolution of barcode images.

Overview

The GenerateAPI interface offers several methods for generating barcodes through different types of HTTP requests:

generate: Generates a barcode via GET request.
generateBody: Generates a barcode via POST request with JSON or XML body.
generateMultipart: Generates a barcode via POST request with multipart form data.

Key Parameters for Setting Barcode Size

To control the size of a barcode, the following properties in the request objects can be configured:

imageHeight: Specifies the height of the barcode image.
imageWidth: Specifies the width of the barcode image.
resolution: Defines the resolution (DPI) of the barcode image.
units: Defines the measurement units (e.g., pixel, inch, millimeter).

Example Usage

Example 1: Generating a Barcode with GET Request

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageParams = BarcodeImageParams(
    imageFormat: .png,
    units: .pixel,
    resolution: 300,
    imageHeight: 250,
    imageWidth: 500
)

let imageData = try await GenerateAPI.generate(
    barcodeType: .code128,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: imageParams,
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "code128.png"))
print("File 'code128.png' generated.")

Result Image is:

Example 2: Generating a Barcode with POST Request (JSON Body)

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let generateParams = GenerateParams(
    barcodeType: .code128,
    encodeData: EncodeData(data: "Aspose.BarCode Cloud"),
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .png,
        units: .millimeter,
        imageHeight: 30,
        imageWidth: 80
    )
)

let imageData = try await GenerateAPI.generateBody(
    generateParams: generateParams,
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "code128.png"))
print("File 'code128.png' generated.")

Result Image is:

Example 3: Generating a Barcode with POST Request (Form URL Encoded)

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generateMultipart(
    barcodeType: .code128,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .png,
        units: .pixel,
        resolution: 200,
        imageHeight: 160,
        imageWidth: 420
    ),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "code128.png"))
print("File 'code128.png' generated.")

Result Image is:

Conclusion

Setting the correct barcode dimensions ensures optimal readability and compatibility with various scanning devices. With Aspose.BarCode Cloud SDK for Swift, you can customize the barcode’s height, width, and resolution to meet specific requirements, whether for product labeling, logistics, or QR code marketing.

Proper barcode sizing improves scanning accuracy and ensures a better user experience. By setting the right dimensions using Aspose.BarCode Cloud SDK for Swift, you can ensure your barcodes are perfectly tailored for their intended use.

V4: Set Barcode Colorscheme

Mon, 01 Jan 0001 00:00:00 +0000

This documentation provides a comprehensive guide on how to set the colorscheme for barcodes using the Aspose.BarCode Cloud SDK for Swift. The API allows customization of barcode appearance, including foreground and background colors, ensuring your barcodes match your design needs.

Overview

The GenerateAPI interface includes methods to generate barcodes using different request formats:

generate: GET request with parameters in route and query string.
generateBody: POST request with parameters in the body (JSON or XML).
generateMultipart: POST request with parameters in multipart form.

Colorscheme Parameters

The foregroundColor and backgroundColor properties enable you to define the colors for the barcode:

foregroundColor: Specifies the color of the bars and text.
backgroundColor: Specifies the background color of the barcode image.

Both properties accept standard color names or ARGB values (e.g., AliceBlue or #FF000000).

Examples

Example 1: Setting Colors Using GET Request

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generate(
    barcodeType: .qr,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .png,
        foregroundColor: "#FF0000",
        backgroundColor: "#FFFF00"
    ),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "colored-qr.png"))
print("File 'colored-qr.png' generated.")

Result Image is:

Example 2: Setting Colors Using POST Request with JSON Body

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let generateParams = GenerateParams(
    barcodeType: .code39,
    encodeData: EncodeData(data: "Aspose"),
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .jpeg,
        foregroundColor: "Navy",
        backgroundColor: "White"
    )
)

let imageData = try await GenerateAPI.generateBody(
    generateParams: generateParams,
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "colored-code39.jpeg"))
print("File 'colored-code39.jpeg' generated.")

Result Image is:

Example 3: Setting Colors Using Multipart Form POST

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generateMultipart(
    barcodeType: .pdf417,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .gif,
        foregroundColor: "DarkGreen",
        backgroundColor: "LightYellow"
    ),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "colored-pdf417.gif"))
print("File 'colored-pdf417.gif' generated.")

Result Image is:

Conclusion

With GenerateAPI in Aspose.BarCode Cloud SDK for Swift, you can easily generate barcodes with customized colors. Whether you prefer GET, POST with JSON, or multipart form POST, the flexibility of this API ensures seamless integration and customization of barcodes in your applications.

V4: Customize Barcode Appearance

Mon, 01 Jan 0001 00:00:00 +0000

This documentation explains how to customize the appearance of barcodes using the Aspose.BarCode Cloud SDK for Swift. It provides details on the available methods, customization options, and examples of usage.

Methods

generate: Generates a barcode via GET request.
generateBody: Generates a barcode via POST request with JSON or XML body.
generateMultipart: Generates a barcode via POST request with multipart form data.

Customization Options

When generating a barcode, you can customize various aspects of its appearance using the properties of the request classes.

Key Properties:

barcodeType: Specifies the type of barcode to generate (e.g. QR, Aztec, Pdf417, Code39, etc).
data: The data to encode in the barcode.
imageFormat: Specifies the output format of the barcode image (e.g., Png, Jpeg, Svg).
foregroundColor: Color of the barcode bars, supports standard color names or ARGB values (e.g., AliceBlue or #FF000000).
backgroundColor: Background color of the barcode image.
textLocation: Position of the code text relative to the barcode (Below, Above, None).
units: Measurement units for image dimensions (Pixel, Inch, Millimeter).
resolution: Resolution of the image in dpi.
imageHeight and imageWidth: Dimensions of the barcode image.
rotationAngle: Rotation angle of the barcode (e.g., 0, 90, 180).

Barcode Type-Specific Parameters

In addition to the common appearance settings above, the API exposes advanced parameters that apply only to specific barcode types. They are ignored when a different barcode type is generated.

QR, MicroQR and RectMicroQR

qrEncodeMode: QR barcode encode mode (Auto, Extended, Binary, ECI).
qrErrorLevel: QR error correction level (LevelL, LevelM, LevelQ, LevelH).
qrVersion: QR barcode version (Auto, Version01–Version40). Auto selects the smallest version that fits the data.
qrECIEncoding: ECI encoding for the QR barcode data (e.g., UTF8, ISO_8859_1).
qrAspectRatio: QR barcode aspect ratio, from 0 to 1.
microQRVersion: MicroQR version (Auto, M1–M4). Used when the barcode type is MicroQR.
rectMicroQrVersion: RectMicroQR version (Auto, R7x43–R17x139). Used when the barcode type is RectMicroQR.

Code128

code128EncodeMode: Controls which Code 128 subset is used (Auto, CodeA, CodeB, CodeAB, CodeC, CodeAC, CodeBC).

PDF417, MacroPDF417 and MicroPDF417

pdf417EncodeMode: PDF417 encode mode (Auto, Binary, ECI, Extended).
pdf417ErrorLevel: PDF417 error correction level (Level0–Level8).
pdf417ECIEncoding: ECI encoding for the PDF417 barcode data.
pdf417Truncate: Whether to use the truncated PDF417 format (removes the right-side stop pattern).
pdf417Columns: Number of columns (1–30, or 0 for auto).
pdf417Rows: Number of rows (3–90, or 0 for automatic).
pdf417AspectRatio: Height/width ratio of the barcode module (2–5 for MicroPDF417; 3–5 for PDF417 and MacroPDF417).
pdf417MacroCharacters: Macro character to prepend for structured append (None, Macro05, Macro06).
pdf417IsReaderInitialization: Whether the barcode is used for reader initialization (programming).
pdf417IsLinked: Whether to use linked mode (for MicroPDF417).
pdf417IsCode128Emulation: Whether to use Code128 emulation (for MicroPDF417).

Examples

Example 1: Generating a Barcode with GET Request

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generate(
    barcodeType: .code128,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .png,
        textLocation: .above,
        rotationAngle: 90
    ),
    code128Params: Code128Params(code128EncodeMode: .codeB),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "code128-appearance.png"))
print("File 'code128-appearance.png' generated.")

Result Image is:

Example 2: Generating a Barcode with POST Request (JSON Body)

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let generateParams = GenerateParams(
    barcodeType: .qr,
    encodeData: EncodeData(data: "Aspose.BarCode Cloud"),
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .jpeg,
        foregroundColor: "DarkBlue",
        backgroundColor: "White",
        rotationAngle: 180
    ),
    qrParams: QrParams(
        qrEncodeMode: .auto,
        qrErrorLevel: .levelH,
        qrVersion: .auto
    )
)

let imageData = try await GenerateAPI.generateBody(
    generateParams: generateParams,
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "qr-appearance.jpeg"))
print("File 'qr-appearance.jpeg' generated.")

Result Image is:

Example 3: Generating a Barcode with POST Request (Multipart Form)

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generateMultipart(
    barcodeType: .pdf417,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(
        imageFormat: .svg,
        foregroundColor: "Black",
        backgroundColor: "White"
    ),
    pdf417Params: Pdf417Params(
        pdf417EncodeMode: .auto,
        pdf417ErrorLevel: .level4,
        pdf417Columns: 6,
        pdf417Rows: 12
    ),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "pdf417-appearance.svg"))
print("File 'pdf417-appearance.svg' generated.")

Result Image is:

V4: Save Generated Barcodes

Mon, 01 Jan 0001 00:00:00 +0000

The Aspose.BarCode Cloud SDK for Swift by the GenerateAPI provides methods to generate barcodes to the Data. Then you can work with result in order to obtain the desired outcomes. This API supports various barcode formats and configurations, enabling users to customize barcode generation to fit their needs.

Methods

generate: Generates a barcode via GET request.
generateBody: Generates a barcode via POST request with JSON or XML body.
generateMultipart: Generates a barcode via POST request with multipart form data. All of these methods return a Data.

Saving the Barcode to File

Below are examples demonstrating how to save the generated barcode stream to a file.

Example: Using `generate`

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generate(
    barcodeType: .qr,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(imageFormat: .png),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "barcode.png"))
print("File 'barcode.png' generated.")

Download Result Image

Example: Using `generateBody`

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let generateParams = GenerateParams(
    barcodeType: .qr,
    encodeData: EncodeData(dataType: .stringData, data: "Aspose.BarCode Cloud"),
    barcodeImageParams: BarcodeImageParams(imageFormat: .jpeg)
)

let imageData = try await GenerateAPI.generateBody(
    generateParams: generateParams,
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "qrcode.jpeg"))
print("File 'qrcode.jpeg' generated.")

Download Result Image

Example: Using `generateMultipart`

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try await GenerateAPI.generateMultipart(
    barcodeType: .pdf417,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(imageFormat: .png),
    apiConfiguration: client.apiConfiguration
)

try imageData.write(to: URL(fileURLWithPath: "pdf417.png"))
print("File 'pdf417.png' generated.")

Download Result Image

Conclusion

The Aspose.BarCode Cloud SDK for Swift offers a robust solution for generating barcodes in various formats, with flexible configuration options. By using the provided methods, developers can easily create and save barcode images to files, streamlining workflows that require barcode generation. Whether you’re working with simple barcodes like Code128 or more complex ones like QR Codes and DataMatrix, this API provides the tools needed to customize and produce high-quality barcode images.

Documentation – Generate barcodes

V4: Set Barcode Text

GenerateAPI

Methods

Setting Barcode Text

Properties

Supported Data Types

Barcode Generation Example

Example 1: Generating a Barcode with GET Request

Example 2: Generating a Barcode with POST Request (JSON Body)

Example 3: Generating a Barcode with POST Request (Multipart Form)

V4: Set Barcode Size

Overview

Key Parameters for Setting Barcode Size

Example Usage

Example 1: Generating a Barcode with GET Request

Example 2: Generating a Barcode with POST Request (JSON Body)

Example 3: Generating a Barcode with POST Request (Form URL Encoded)

Conclusion

V4: Set Barcode Colorscheme

Overview

Colorscheme Parameters

Examples

Example 1: Setting Colors Using GET Request

Example 2: Setting Colors Using POST Request with JSON Body

Example 3: Setting Colors Using Multipart Form POST

Conclusion

V4: Customize Barcode Appearance

Methods

Customization Options

Barcode Type-Specific Parameters

QR, MicroQR and RectMicroQR

Code128

PDF417, MacroPDF417 and MicroPDF417

Examples

Example 1: Generating a Barcode with GET Request

Example 2: Generating a Barcode with POST Request (JSON Body)

Example 3: Generating a Barcode with POST Request (Multipart Form)

V4: Save Generated Barcodes

Methods

Saving the Barcode to File

Example: Using generate

Example: Using generateBody

Example: Using generateMultipart

Conclusion

Example: Using `generate`

Example: Using `generateBody`

Example: Using `generateMultipart`