AeroModel

AeroModel

Documentation

scale (and referencePlane)

Aircraft sizing strategy within the canvas. Allows comparing multiple aircraft at the same real-world scale.

scale values

ValueDescription
none (default)No scaling. Aircraft is sized by width × zoomLevel × (1 - 2×margin).
fleetSizes each aircraft proportionally to a reference plane (referencePlane), based on its real length in meters.
absoluteAircraft always fills canvasWidth × zoomLevel × (1 - 2×margin), regardless of model.

referencePlane parameter

Slug of the aircraft used as "100%" in fleet mode. If absent → the API uses its largest known aircraft (currently A380).

API examples

scale=fleet

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A380&airline=EK&scale=fleet&referencePlane=airbus-a380-800&resolution=card
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&scale=fleet&referencePlane=airbus-a380-800&resolution=card
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=B737&airline=AF&scale=fleet&referencePlane=airbus-a380-800&resolution=card
A380 (reference)A320B737-800

All images have the same width (e.g. 1024 px) but the aircraft inside is sized according to its real length. Displayed side by side, proportions are faithful to reality.

scale=absolute

Force every aircraft to occupy the same visual space regardless of its real size. Handy for uniform cards:

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A380&airline=EK&scale=absolute&resolution=card
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=B737&airline=AF&scale=absolute&resolution=card

Both aircraft fill the canvas identically.

scale=none (default)

Standard behavior: each image is sized individually by width / zoomLevel / margin. No consistency between different aircraft.

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

Combine

  • scale=fleet + pitch=15 + align=bottom: a takeoff scene fleet, all on the same baseline.
  • scale=fleet + background=%23001a33: fleet on a uniform background for a comparison sheet.

Response headers

x-compose-scale: fleet
x-compose-reference-plane: airbus-a380-800

See also