Class EmbedSettings

Hierarchy

EmbedSettings

Index

Constructors

Properties

backgroundImagesetName creditMode foregroundImagesetName showCoordinateReadout showCrosshairs tourUrl wtmlPlace wtmlUrl

Methods

asSettings fromQueryParams

Constructors

constructor

new EmbedSettings(): EmbedSettings
Returns EmbedSettings

Properties

backgroundImagesetName

backgroundImagesetName: string = ""

creditMode

creditMode: CreditMode = CreditMode.Default

foregroundImagesetName

foregroundImagesetName: string = ""

showCoordinateReadout

showCoordinateReadout: boolean = false

showCrosshairs

showCrosshairs: boolean = false

tourUrl

tourUrl: string = ""

wtmlPlace

wtmlPlace: string = ""

wtmlUrl

wtmlUrl: string = ""

Methods

asSettings

asSettings(): BaseEngineSetting[]
Return a set of BaseEngineSetting values implied by this configuration. (The BaseEngineSetting type is defined in the @wwtelescope/engine-types module.)

Returns BaseEngineSetting[]
A list of setting values.
- Defined in index.ts:118

`Static` fromQueryParams

fromQueryParams(qp): EmbedSettings
Parameters
- qp: IterableIterator<[string, string]>
Returns EmbedSettings
- Defined in index.ts:42

Generated using TypeDoc