Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Welcome to Struct PIM 4
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  • Supported query parameters
  • Examples

Media format

Struct PIM supports formatting media directly through its media module based on querystring parameters.

PreviousWebhooksNextIntroduction

Last updated 2 months ago

The media module delivering assets provides methods to perform various manipulation functions on a given image or file based on querystring parameters.

Supported query parameters

Parameter
Description

width

For mode Pad passing just one dimension will automatically preserve the aspect ratio of the original image.

For mode BoxPad when upscaling an image the image pixels themselves are not resized, rather the image is padded to fit the given dimensions. If downscaling it will behave the same as Pad.

height

For mode Pad passing just one dimension will automatically preserve the aspect ratio of the original image.

For mode BoxPad when upscaling an image the image pixels themselves are not resized, rather the image is padded to fit the given dimensions. If downscaling it will behave the same as Pad.

format

Converts current asset to a new image format.

Supported image formats: jpg, png, webp, gif

Supported file to image formats: pdf, psd, eps

mode

The following modes are supported:

  • Pad Passing a single dimension will automatically preserve the aspect ratio of the original image. If the requested aspect ratio is different then the image will be padded to fit. Widths and heights can optionally also be passed as a ratio This is default.

  • BoxPad When upscaling an image the image pixels themselves are not resized, rather the image is padded to fit the given dimensions. When downscaling the image is resized using the rules defined by Pad

  • Crop Resizes the image to the given dimensions. If the set dimensions do not match the aspect ratio of the original image then the output is cropped to match the new aspect ratio.

quality

Alters the output quality of the current image. This method will only effect the

output quality of images that allow lossy processing.

anchor

Anchor positions supported:

  • center

  • top

  • right

  • bottom

  • left

  • topleft

  • topright

  • bottomleft

  • bottomright

Center is default.

bgcolor

When padding applied and or image includes transparency, it is possible to set the color of the padding/baggrund.

Examples

?width=100
?height=10
?format=webp
&mode=boxpad
&quality=90
&mode=crop&anchor=top
&bgcolor=ffffff
Original
?width=250
?width=550&height=550&mode=crop&anchor=left
?width=1100&height=1100&mode=boxpad&bgcolor=lightblue