Jump to main content

# Logo

Object defining the LogoID or a grouping (LogoSequenceGroup) of logo height, header placement, particular page or pages where the logo will be applied, and any tool tip text for ADA-compliant documents.

The Implementation Strategies guide contains detailed information and recommended practices when working with logos.

Note: You can only use either LogoID or the LogoSequenceGroup collection of parameters.

Parameter | Type | Description
--- | --- | ---
LogoID | string | Allows only passing an ID to the logo instead of the complete logo element per document. Only supported for InlinePackage.

Table 1. LogoSequenceGroup
Parameter | Type | Description
--- | --- | ---
LogoID | string | A unique identifier for a specific logo.
Image | base64string | The location of the image to be processed.
Justification | string | Specifies the header location of the logo with available values of "top," "center," or "right." The default location is "Left."
Placement | string | Specifies the pages where the logo will be placeed with available values of "AllPages," "FirstPageOnly," or "AllExceptFirst." The default value is "AllPages" if no value is entered.
HeightInInches | float | Specifies the height of the logo. Unless otherwise specified, auto-scaling will occur. The maxiumum height can be no bigger than 1.5 inches. Note: You must specify either height or width.
WidthInInches | float | Specifies the width of the logo. Unless otherwise specified, auto-scaling will occur. Note: You must specify either height or width.
AlternateText | string | Applies a string value used for hover text in ADA-compliant documents. This is an optional field.