<!-- generated by scripts/docs/generate-reference.ts — do not edit -->

astro_render_planetary_cycle

Mercury / Venus / Mars synodic cycle renders (petals, synodic, promethean).

  • Layer: render
  • Methods: cycle
  • Free tier:
  • Paid tier: cycle

Description

Mercury / Venus / Mars synodic cycle renders (petals, synodic, promethean).

Methods:
  cycle [Paid] — Mercury/Venus/Mars synodic-cycle render (petals, synodic, or promethean layout) over a date range

Input schema

cycle

FieldTypeRequiredConstraints
planet"mercury" | "venus" | "mars"yes
layout"petals" | "synodic" | "promethean"yes
dateRange.fromobjectyes
dateRange.toobjectyes
marker.dateobjectyes
marker.labelstringnominLength 1, maxLength 24
sizePxintegernomin 320, max 1600, int
stepDaysnumbernomin 0.25, max 5
mode"light" | "dark"no
palette.backgroundany | "transparent" | stringno
palette.linestringno
palette.retrostringno
palette.textstringno
palette.accentstringno

Example request

{
  "method": "cycle",
  "planet": "venus",
  "layout": "petals",
  "dateRange": {
    "from": {
      "year": 2024,
      "month": 1,
      "day": 1
    },
    "to": {
      "year": 2025,
      "month": 12,
      "day": 31
    }
  }
}

Example response (captured; long values elided)

{
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 760 760\" width=\"760\" height=\"760\"><rect width=\"760\" height=\"760\" fi… (141655 chars total)",
  "events": [
    {
      "kind": "superior-conjunction",
      "jdUT": 2460466.148229,
      "elongation": 0,
      "dateUT": {
        "year": 2024,
        "month": 6,
        "day": 4
      }
    },
    {
      "kind": "max-elongation-east",
      "jdUT": 2460685.854749,
      "elongation": 47.165205,
      "dateUT": {
        "year": 2025,
        "month": 1,
        "day": 10
      }
    },
    {
      "kind": "inferior-conjunction",
      "jdUT": 2460757.54688,
      "elongation": -0.000005,
      "dateUT": {
        "year": 2025,
        "month": 3,
        "day": 23
      }
    },
    {
      "kind": "max-elongation-west",
      "jdUT": 2460827.373364,
      "elongation": -45.843818,
      "dateUT": {
        "year": 2025,
        "month": 5,
        "day": 31
      }
    }
  ],
  "samples": 732
}

Rendered example

astro_render_planetary_cycle.cycle example render (watchmaker style)