Skip to the content

Hoshi Stars星

The stars you can see without a telescope, with names, colours and distances; the 88 constellations with their lines and boundaries; the Messier objects; and seven map projections to draw them on.

Hoshi is the Japanese word 星 for a star. About the name

Contents

Reference · The data door: hand the package your own stars or objects as a source with its own licence and credit, and see whose data is on the screen

StarSkyOptionstype

What starSky takes.

Import it

import type { StarSkyOptions } from "@johnmorrisdotca/hoshi-stars/door";

Definition

interface StarSkyOptions {
    sources?: readonly StarSource[];
    budgetBytes?: number;
    maxTiles?: number;
    maxInFlight?: number;
    onChange?: () => void;
    onCredits?: (credits: Credit[]) => void;
}

Members

NameTypeDescription
sources (optional)readonly StarSource[] | undefined

The sources to start with. Each is checked by validateSource at once.

budgetBytes (optional)number | undefined

The bytes of decoded tiles held, all sources together: 48 MB where left out.

maxTiles (optional)number | undefined

The most tiles held, all sources together: no limit where left out.

maxInFlight (optional)number | undefined

The most loads in flight for one source: 6 where left out.

onChange (optional)(() => void) | undefined

Called when tiles have arrived, failed, or a source was added, removed or switched, so that the page draws again.

onCredits (optional)((credits: Credit[]) => void) | undefined

Called when the set of sources that contributed to the last drawn stars changes (not at each draw), with the new credits.

Examples

import { ucac4Source, type StarSkyOptions } from "@johnmorrisdotca/hoshi-stars/door";

const options: StarSkyOptions = { sources: [ucac4Source()], budgetBytes: 24 * 1024 * 1024 };
console.log(options.sources?.length);
1

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/hoshi-stars 0.47.0.