ImageSourceSchema

const ImageSourceSchema: ZodObject<{ coordinates: ZodTuple<[ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>], null>; type: ZodLiteral<"image">; url: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ coordinates: ZodTuple<[ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>], null>; type: ZodLiteral<"image">; url: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ coordinates: ZodTuple<[ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>, ZodTuple<[ZodNumber, ZodNumber], null>], null>; type: ZodLiteral<"image">; url: ZodString; }, ZodTypeAny, "passthrough">>

Defined in: packages/core/src/schemas/source.schema.ts:722

Image source configuration.

Remarks

Display a single image on the map anchored to geographic coordinates. Useful for overlaying maps, floor plans, or custom imagery.

Coordinate Order: Four corners must be specified clockwise starting from top-left:

1. Top-left
2. Top-right
3. Bottom-right
4. Bottom-left

Example

source:
  type: image
  url: "https://example.com/overlay.png"
  coordinates:
    - [-80.425, 46.437]  # top-left
    - [-71.516, 46.437]  # top-right
    - [-71.516, 37.936]  # bottom-right
    - [-80.425, 37.936]  # bottom-left

See

MapLibre Image Source