mirror of
https://github.com/cosinekitty/astronomy.git
synced 2026-02-05 21:22:12 -05:00
e12d2e88c6
The documentation for SearchRiseSet and SearchAltitude needed clarification about refraction and the part of the body solved for (center versus limb). The JavaScript version was especially lacking compared to documentation for the other languages. Also documented SearchAltitude's limitations; it does not work at or near maximum/minimum altitude. Mention that user-defined stars are allowed for SearchRiseSet, SearchAltitude, and SearchHourAngle. Fixed a couple places where the Kotlin documentation had broken links to other functions.
27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
//[astronomy](../../index.md)/[io.github.cosinekitty.astronomy](index.md)/[searchLocalSolarEclipse](search-local-solar-eclipse.md)
|
|
|
|
# searchLocalSolarEclipse
|
|
|
|
fun [searchLocalSolarEclipse](search-local-solar-eclipse.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)
|
|
|
|
Searches for a solar eclipse visible at a specific location on the Earth's surface.
|
|
|
|
This function finds the first solar eclipse that occurs after startTime. A solar eclipse may be partial, annular, or total. See [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md) for more information.
|
|
|
|
To find a series of solar eclipses, call this function once, then keep calling [nextLocalSolarEclipse](next-local-solar-eclipse.md) as many times as desired, passing in the peak value returned from the previous call.
|
|
|
|
IMPORTANT: An eclipse reported by this function might be partly or completely invisible to the observer due to the time of day. See [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md) for more information about this topic.
|
|
|
|
See [localSolarEclipsesAfter](local-solar-eclipses-after.md) for convenient iteration of consecutive eclipses.
|
|
|
|
#### Return
|
|
|
|
Information about the first solar eclipse visible at the specified observer location.
|
|
|
|
## Parameters
|
|
|
|
| | |
|
|
|---|---|
|
|
| startTime | The date and time for starting the search for a solar eclipse. |
|
|
| observer | The geographic location of the observer. |
|