Abyssale Developer Hub
  • Getting Started
  • Rest API
    • Overview - Rest API
    • Authentication
    • Designs
      • Design Details
    • Generation
      • Design information
      • Synchronous generation
        • Generate single image
      • Asynchronous generation
        • Generate Multi-Format images
        • Generate Multi-Format PDFs for Printing
        • Generate Multi-Page PDF for Printing
        • Generate Multi-Format Videos
        • Generate Multi-Format Animated GIFs
        • Generate HTML5 Banner Ads
          • ad network
      • Element properties
        • Root
        • Text
        • Button
        • Image
        • Logo
        • Shape
        • Rating
        • Illustration
        • QR Code
        • Video
        • Audio
      • Errors
    • Image Export
    • Fonts
    • Annexes
    • API Reference
  • Dynamic Images
    • Overview - Dynamic Images
    • Dynamic Image generation with URL
  • Webhooks
    • Overview - Webhooks
    • Events
      • Design
      • Banner
      • Global events
Powered by GitBook
On this page
  1. Rest API
  2. Generation
  3. Element properties

Illustration

Illustration component - Abyssale REST API

PreviousRatingNextQR Code

Last updated 12 months ago

Abyssale supports the following illustration packages:

  • (Icons)

  • (Illustrations)

  • (Icons)

  • (Emojis)

Available properties:

Property
Description

illustration_type

The illustration library that will be used to retrieve the related illustration name.

Supported values:

  • undraw

  • feather

  • twemoji

  • material_icons

illustration_file

The illustration name. It corresponds to:

  • Feather icons: The name given on the feature icons website.

  • Undraw: The name of the related illustration file (without the file extension)

  • Material Icons: The icon id (example: visibility_off)

illustration_properties

alignment

opacity

Integer between 0 and 100. Opacity of the image

Illustration Properties

Undraw, feather and material icons can have an illustration_properties property.

Property
Description

primary_color

This attribute should be located within the "illustration_properties" section of your post code.

Examples:

"illustration_file": "tropical_fish"

"alignment": "middle center"

"opacity": 68,

"illustration_file": "happy_2021",

"illustration_properties": {

"primary_color": "#FF0000"

}

"opacity": 68,

"illustration_file": "happy_2021",

"illustration_properties": {

"primary_color":"cmyka(0,100,100,0,100)"

}

Twemoji: Name of the emoji. You can found the list .

String: or (for print) Color of the illustration.

Feather icons
Undraw
Material icons
Twemoji
here
Go to Illustration properties documentation
6-8 digits hexa color
cmyka format
Go to Alignment documentation