リファレンス · 数値から描いた星のSVGの絵と、太陽との大きさくらべ
starComparison関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The star beside the Sun at one scale, as SVG text. A star smaller than about a hundred Suns is drawn as a disc next to the Sun's disc. A bigger one fills the picture, with the Sun a dot at its centre and the orbits of Earth (and Mars and Jupiter where they fit) drawn over it, so a supergiant's size can be read against the solar system. The picture says how many times the Sun's radius the star is.
インポート
import { starComparison } from "@johnmorrisdotca/hoshi-stars/portrait";定義
function starComparison(profile: StarProfile, options?: PortraitOptions): string | undefined引数
| 名前 | 型 | 説明 |
|---|---|---|
profile | StarProfile | A star's profile from |
options (省略可) | PortraitOptions | Size, language, name and background. |
戻り値
string | undefined
An SVG document as a string, or undefined where the profile has no radius or no temperature.
例
import { starByName } from "@johnmorrisdotca/hoshi-stars";
import { starProfile } from "@johnmorrisdotca/hoshi-stars/profile";
import { starComparison } from "@johnmorrisdotca/hoshi-stars/portrait";
const svg = starComparison(starProfile(starByName("Aldebaran")!), { name: "Aldebaran" });
console.log(svg?.includes("Earth's orbit"));false出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。