AeroModel

AeroModel

Documentation

marginPercent

Margin as a percentage of the canvas width, added on each side of the aircraft.

Range

  • Min: 0 (aircraft edge-to-edge)
  • Max: 45 (10% of the canvas left for the aircraft)
  • Default: 8
  • Step: 0.01

Note: any call with marginPercent different from the default triggers the composition pipeline. Output is served as PNG (header x-format-coerced: png if jpg/webp was requested).

API examples

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&marginPercent=0
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&marginPercent=8
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&marginPercent=15
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&marginPercent=25

Visuals (A320 profile 90°, contain, zoomLevel=1)

marginPercent=0marginPercent=8 (default)marginPercent=15marginPercent=25

Behavior

  • With zoomType=contain: the margin is guaranteed on each side.
  • With zoomType=fill: the margin acts as a crop offset.
  • If zoomLevel>1 AND marginPercent>0, they may compensate (zoom overflows the margin).

Use cases

ContextmarginPercent
Tight view0-3
Standard catalog8 (default)
Airy / minimalist view15-20
Thumbnail with room for text overlay15-25

Errors

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&marginPercent=80&format=json
→ 400 { "error": "invalid render options", "details": ["marginPercent must be a number between 0 and 45"] }

See also