Global

Members

(constant) FPS :number

The FPS of the animation. `paintEcg` will try to keep the animation at this rate, for displays that have slower or faster refresh rates.
Type:
  • number
Source:

(constant) FPS :number

The FPS of the animation. `paintEcg` will try to keep the animation at this rate, for displays that have slower or faster refresh rates.
Type:
  • number
Source:

(constant) GRAVITY :number

The acceleration due to "gravity" applied on all falling objects in the animation, in px/ms^2.
Type:
  • number
Source:

(constant) GRAVITY :number

The acceleration due to "gravity" applied on all falling objects in the animation, in px/ms^2.
Type:
  • number
Source:

(constant) PERIOD

The period of the heartbeat shape, in whatever units `ecgPoints` is in. Increase to increase the spacing between heartbeats, but it's mostly a guessing game.
Source:

(constant) PERIOD

The period of the heartbeat shape, in whatever units `ecgPoints` is in. Increase to increase the spacing between heartbeats, but it's mostly a guessing game.
Source:

(constant) XSHIFT :number

Horizontal shift factor to be added to each point in `ecgPoints`. This is because the image I got wasn't centered at the origin.
Type:
  • number
Source:

(constant) XSHIFT :number

Horizontal shift factor to be added to each point in `ecgPoints`. This is because the image I got wasn't centered at the origin.
Type:
  • number
Source:

(constant) YSHIFT :number

Vertical shift factor to be added to each point in `ecgPoints`.
Type:
  • number
Source:

(constant) YSHIFT :number

Vertical shift factor to be added to each point in `ecgPoints`.
Type:
  • number
Source:

(constant) context :CanvasRenderingContext2D

The `CanvasRenderingContext2D` for `result`.
Type:
  • CanvasRenderingContext2D
Source:

(constant) context :CanvasRenderingContext2D

The `CanvasRenderingContext2D` for `result`.
Type:
  • CanvasRenderingContext2D
Source:

cookieFalling :boolean

Whether to animate a new cookie falling.
Type:
  • boolean
Source:

cookieFalling :boolean

Whether to animate a new cookie falling.
Type:
  • boolean
Source:

(constant) defaultPreferenceKeyValues :defaultPreferenceKeyValues

An object that has as all the preference keys and values.
Type:
Source:

(constant) defaultPreferenceKeyValues :defaultPreferenceKeyValues

An object that has as all the preference keys and values.
Type:
Source:

(constant) ecgGraph :SVGSVGElement

The heartbeat graph.
Type:
  • SVGSVGElement
Source:

(constant) ecgGraph :SVGSVGElement

The heartbeat graph.
Type:
  • SVGSVGElement
Source:

(constant) ecgHistory :Array.<number>

A queue of points (new elements added to the beginning) representing the ECG graph. Kept to a maximum of `ecgLength` items.
Type:
  • Array.<number>
Source:

(constant) ecgHistory :Array.<number>

A queue of points (new elements added to the beginning) representing the ECG graph. Kept to a maximum of `ecgLength` items.
Type:
  • Array.<number>
Source:

(constant) ecgLength :number

The number of SVG units in width of the fake heartbeat graph.
Type:
  • number
Source:

(constant) ecgLength :number

The number of SVG units in width of the fake heartbeat graph.
Type:
  • number
Source:

(constant) ecgPath :SVGPathElement

The `` element that draws the ECG graph.
Type:
  • SVGPathElement
Source:

(constant) ecgPath :SVGPathElement

The `` element that draws the ECG graph.
Type:
  • SVGPathElement
Source:

(constant) ecgPoints :Array.<Array.<number, number>>

Some points on an image of an ECG graph I found on Google Images that I manually marked out in MS Paint. Used to form the piecewise linear `ecg` polyline.
Type:
  • Array.<Array.<number, number>>
Source:

(constant) ecgPoints :Array.<Array.<number, number>>

Some points on an image of an ECG graph I found on Google Images that I manually marked out in MS Paint. Used to form the piecewise linear `ecg` polyline.
Type:
  • Array.<Array.<number, number>>
Source:

(constant) fates :Array.<string>

Possible outcomes for the fate line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) fates :Array.<string>

Possible outcomes for the fate line in a palm reading.
Type:
  • Array.<string>
Source:

flipCamera :boolean

Whether the camera should be horizontally flipped (for front-facing cameras).
Type:
  • boolean
Source:

flipCamera :boolean

Whether the camera should be horizontally flipped (for front-facing cameras).
Type:
  • boolean
Source:

(constant) fortunes :Array.<string>

Array of general, college, and collage-romance type fortunes
Type:
  • Array.<string>
Source:

(constant) fortunes :Array.<string>

Array of general, college, and collage-romance type fortunes
Type:
  • Array.<string>
Source:

frameId :number|null

The ID returned by `window.requestAnimationFrame`, used to cancel it or determine whether it is animating. `null` if `paintEcg` is not animating.
Type:
  • number | null
Source:

frameId :number|null

The ID returned by `window.requestAnimationFrame`, used to cancel it or determine whether it is animating. `null` if `paintEcg` is not animating.
Type:
  • number | null
Source:

(constant) heads :Array.<string>

Possible outcomes for the head line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) heads :Array.<string>

Possible outcomes for the head line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) hearts :Array.<string>

Possible outcomes for the heart line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) hearts :Array.<string>

Possible outcomes for the heart line in a palm reading.
Type:
  • Array.<string>
Source:

lastInstructionElem :HTMLParagraphElement|null

The currently displayed `.instructions` element.
Type:
  • HTMLParagraphElement | null
Source:

lastInstructionElem :HTMLParagraphElement|null

The currently displayed `.instructions` element.
Type:
  • HTMLParagraphElement | null
Source:

lastTime :number

The timestamp of the last time `paint` was called.
Type:
  • number
Source:

lastTime :number

The timestamp of the last time `paint` was called.
Type:
  • number
Source:

(constant) leftWheel :Wheel

The left wheel.
Type:
Source:

(constant) leftWheel :Wheel

The left wheel.
Type:
Source:

(constant) lifes :Array.<string>

Possible outcomes for the life line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) lifes :Array.<string>

Possible outcomes for the life line in a palm reading.
Type:
  • Array.<string>
Source:
The list of entries in the navigation menu.
Type:
Source:
The list of entries in the navigation menu.
Type:
Source:
The menu icon, which is a focusable element to allow the menu contents to be tab accessible.
Type:
  • HTMLAnchorElement
Source:
The menu icon, which is a focusable element to allow the menu contents to be tab accessible.
Type:
  • HTMLAnchorElement
Source:
The created `
Type:
  • HTMLElement
Source:
The created `
Type:
  • HTMLElement
Source:

(constant) readAnother :HTMLButtonElement

The button for resetting the app and reading another hand.
Type:
  • HTMLButtonElement
Source:

(constant) readAnother :HTMLButtonElement

The button for resetting the app and reading another hand.
Type:
  • HTMLButtonElement
Source:

(constant) requestBtn :HTMLButtonElement

The button that requests for camera access.
Type:
  • HTMLButtonElement
Source:

(constant) requestBtn :HTMLButtonElement

The button that requests for camera access.
Type:
  • HTMLButtonElement
Source:

(constant) result :HTMLCanvasElement

A `` that stores a snapshot of the webcam video.
Type:
  • HTMLCanvasElement
Source:

(constant) result :HTMLCanvasElement

A `` that stores a snapshot of the webcam video.
Type:
  • HTMLCanvasElement
Source:

(constant) rightWheel :Wheel

The right wheel.
Type:
Source:

(constant) rightWheel :Wheel

The right wheel.
Type:
Source:

(constant) romantic :Map.<string, string>

Mapping of zodiac pairs to their college romance analysis.
Type:
  • Map.<string, string>
Source:

(constant) romantic :Map.<string, string>

Mapping of zodiac pairs to their college romance analysis.
Type:
  • Map.<string, string>
Source:

(constant) shakeV :number

The decrease in shake intensity, in px/ms.
Type:
  • number
Source:

(constant) shakeV :number

The decrease in shake intensity, in px/ms.
Type:
  • number
Source:

simTime :number

Tracks how much time has been "simulated" by `paintEcg`. This is used for refresh rate independence. For example, if there was a lag spike and real time passes more than usual by the next animation frame, then `paintEcg` might simulate two simulation "frames" in the same animation frame so the animation doesn't slow down.
Type:
  • number
Source:

simTime :number

Tracks how much time has been "simulated" by `paintEcg`. This is used for refresh rate independence. For example, if there was a lag spike and real time passes more than usual by the next animation frame, then `paintEcg` might simulate two simulation "frames" in the same animation frame so the animation doesn't slow down.
Type:
  • number
Source:

startTime :number

The time when animation and simulation started.
Type:
  • number
Source:

startTime :number

The time when animation and simulation started.
Type:
  • number
Source:

(constant) suns :Array.<string>

Possible outcomes for the sun line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) suns :Array.<string>

Possible outcomes for the sun line in a palm reading.
Type:
  • Array.<string>
Source:

(constant) synth :SpeechSynthesis

A reference to `window.speechSynthesis`.
Type:
  • SpeechSynthesis
Source:

(constant) synth :SpeechSynthesis

A reference to `window.speechSynthesis`.
Type:
  • SpeechSynthesis
Source:

(constant) tabContents :ArrayLike.<HTMLDivElement>

Each tabs' tab content.
Type:
  • ArrayLike.<HTMLDivElement>
Source:

(constant) tabContents :ArrayLike.<HTMLDivElement>

Each tabs' tab content.
Type:
  • ArrayLike.<HTMLDivElement>
Source:

(constant) tabLabels :ArrayLike.<HTMLInputElement>

The tabs' `` elements.
Type:
  • ArrayLike.<HTMLInputElement>
Source:

(constant) tabLabels :ArrayLike.<HTMLInputElement>

The tabs' `` elements.
Type:
  • ArrayLike.<HTMLInputElement>
Source:

timeoutId :number

Stores the ID of the last `setTimeout` call by `wait`, so it can be cancelled by `clearTimeout`.
Type:
  • number
Source:
Example
wait(1000);
clearTimeout(timeoutId);

timeoutId :number

Stores the ID of the last `setTimeout` call by `wait`, so it can be cancelled by `clearTimeout`.
Type:
  • number
Source:
Example
wait(1000);
clearTimeout(timeoutId);

(constant) video :HTMLVideoElement

The `
Type:
  • HTMLVideoElement
Source:

(constant) video :HTMLVideoElement

The `
Type:
  • HTMLVideoElement
Source:

(constant) voiceSelect :HTMLSelectElement

The voice selection dropdown.
Type:
  • HTMLSelectElement
Source:

(constant) voiceSelect :HTMLSelectElement

The voice selection dropdown.
Type:
  • HTMLSelectElement
Source:

voices :Array.<SpeechSynthesisVoice>

A list of voices available by the browser.
Type:
  • Array.<SpeechSynthesisVoice>
Source:

voices :Array.<SpeechSynthesisVoice>

A list of voices available by the browser.
Type:
  • Array.<SpeechSynthesisVoice>
Source:

(constant) webcamWrapper :HTMLDivElement

The wrapper element that holds all the element anchored around the middle of the screen, where the circle with the webcam video is.
Type:
  • HTMLDivElement
Source:

(constant) webcamWrapper :HTMLDivElement

The wrapper element that holds all the element anchored around the middle of the screen, where the circle with the webcam video is.
Type:
  • HTMLDivElement
Source:

(constant) zodiacDateRanges :Record.<string, string>

Mapping of zodiacs to their date range.
Type:
  • Record.<string, string>
Source:

(constant) zodiacDateRanges :Record.<string, string>

Mapping of zodiacs to their date range.
Type:
  • Record.<string, string>
Source:

(constant) zodiacOrder :Array.<string>

The order of the zodiacs along a wheel.
Type:
  • Array.<string>
Source:

(constant) zodiacOrder :Array.<string>

The order of the zodiacs along a wheel.
Type:
  • Array.<string>
Source:

Methods

angleDiff(angle, base) → {number}

Finds the smaller difference between two angles. For example, the difference -170° - 170° should be 20°, because -170° is equivalent to 190°.
Parameters:
Name Type Description
angle number The angle to subtract the base from.
base number The base angle that is subtracted from the angle.
Source:
Returns:
`angle - base`, but it's guaranteed to be between -180° and 180°.
Type
number

angleDiff(angle, base) → {number}

Finds the smaller difference between two angles. For example, the difference -170° - 170° should be 20°, because -170° is equivalent to 190°.
Parameters:
Name Type Description
angle number The angle to subtract the base from.
base number The base angle that is subtracted from the angle.
Source:
Returns:
`angle - base`, but it's guaranteed to be between -180° and 180°.
Type
number

animateCardContainer(cardContainer)

Animates the specified card container element. Applies various animation effects and navigates to the card's link after the animation completes.
Parameters:
Name Type Description
cardContainer HTMLElement The card container element to animate.
Source:

animateCardContainer(cardContainer)

Animates the specified card container element. Applies various animation effects and navigates to the card's link after the animation completes.
Parameters:
Name Type Description
cardContainer HTMLElement The card container element to animate.
Source:

determineDateRangeLeft(angle) → {string}

Determines the zodiac sign date range based on the given angle on the left wheel.
Parameters:
Name Type Description
angle number The angle of the left wheel.
Source:
Returns:
The zodiac sign associated with the angle.
Type
string

determineDateRangeLeft(angle) → {string}

Determines the zodiac sign date range based on the given angle on the left wheel.
Parameters:
Name Type Description
angle number The angle of the left wheel.
Source:
Returns:
The zodiac sign associated with the angle.
Type
string

determineDateRangeRight(angle) → {string}

Determines the zodiac sign date range based on the given angle on the right wheel.
Parameters:
Name Type Description
angle number The angle of the right wheel.
Source:
Returns:
The zodiac sign associated with the angle.
Type
string

determineDateRangeRight(angle) → {string}

Determines the zodiac sign date range based on the given angle on the right wheel.
Parameters:
Name Type Description
angle number The angle of the right wheel.
Source:
Returns:
The zodiac sign associated with the angle.
Type
string

determinePairing(angleLeft, angleRight) → {Array}

Gets the zodiac sign pair based on the angles of the left and right wheels.
Parameters:
Name Type Description
angleLeft number The angle of the left wheel.
angleRight number The angle of the right wheel.
Source:
Returns:
An array containing the zodiac sign pair.
Type
Array

determinePairing(angleLeft, angleRight) → {Array}

Gets the zodiac sign pair based on the angles of the left and right wheels.
Parameters:
Name Type Description
angleLeft number The angle of the left wheel.
angleRight number The angle of the right wheel.
Source:
Returns:
An array containing the zodiac sign pair.
Type
Array

disableButton()

Disables button so user cannot click it
Source:

disableButton()

Disables button so user cannot click it
Source:

(async) displayResults()

Displays the results of the pairing and animates the UI elements.
Source:

(async) displayResults()

Displays the results of the pairing and animates the UI elements.
Source:

ecg(time) → {number}

A periodic, piecewiese linear function that draws out the shape of an ECG. The units used in this function are kind of weird, so some guesswork is required to shape it into a nice-looking form for the heartbeat graph.
Parameters:
Name Type Description
time number The x-value of the ECG graph.
Source:
Returns:
The resulting y-value of the graph.
Type
number

ecg(time) → {number}

A periodic, piecewiese linear function that draws out the shape of an ECG. The units used in this function are kind of weird, so some guesswork is required to shape it into a nice-looking form for the heartbeat graph.
Parameters:
Name Type Description
time number The x-value of the ECG graph.
Source:
Returns:
The resulting y-value of the graph.
Type
number

fallFortune()

Sets the animation to make the fortune paper fall.
Source:

fallFortune()

Sets the animation to make the fortune paper fall.
Source:

fallLeft()

Sets the animation to make the left half of the cookie fall.
Source:

fallLeft()

Sets the animation to make the left half of the cookie fall.
Source:

fallNewCookie()

Sets the animation to make a new, full fortune cookie fall.
Source:

fallNewCookie()

Sets the animation to make a new, full fortune cookie fall.
Source:

fallRight()

Sets the animation to make the right half of the cookie fall.
Source:

fallRight()

Sets the animation to make the right half of the cookie fall.
Source:

getMappingLeft(roundedAngle) → {string}

Retrieves the zodiac sign mapping for the given angle on the left wheel.
Parameters:
Name Type Description
roundedAngle number The angle on the left wheel pre-rounded to the nearest 30 degree increment
Source:
Returns:
The corresponding zodiac sign, or `'unknown'` if the angle does not correspond to a zodiac.
Type
string

getMappingLeft(roundedAngle) → {string}

Retrieves the zodiac sign mapping for the given angle on the left wheel.
Parameters:
Name Type Description
roundedAngle number The angle on the left wheel pre-rounded to the nearest 30 degree increment
Source:
Returns:
The corresponding zodiac sign, or `'unknown'` if the angle does not correspond to a zodiac.
Type
string

getMappingRight(roundedAngle) → {string}

Retrieves the zodiac sign mapping for the given angle on the right wheel.
Parameters:
Name Type Description
roundedAngle number The angle on the right wheel pre-rounded to the nearest 30 degree increment
Source:
Returns:
The corresponding zodiac sign, or `'unknown'` if the angle does not correspond to a zodiac.
Type
string

getMappingRight(roundedAngle) → {string}

Retrieves the zodiac sign mapping for the given angle on the right wheel.
Parameters:
Name Type Description
roundedAngle number The angle on the right wheel pre-rounded to the nearest 30 degree increment
Source:
Returns:
The corresponding zodiac sign, or `'unknown'` if the angle does not correspond to a zodiac.
Type
string

getRandomFortune() → {string}

This function will get a random fortune from the fortune array and make sure it does not match the previous one
Source:
Returns:
a random fortune
Type
string

getRandomFortune() → {string}

This function will get a random fortune from the fortune array and make sure it does not match the previous one
Source:
Returns:
a random fortune
Type
string

handleCardContainerClick(event)

Handles the click event on a card container. Prevents the default link behavior, logs the action, and triggers the card container's animation.
Parameters:
Name Type Description
event Event The click event object.
Source:

handleCardContainerClick(event)

Handles the click event on a card container. Prevents the default link behavior, logs the action, and triggers the card container's animation.
Parameters:
Name Type Description
event Event The click event object.
Source:

handleCookieReady()

A handler called whenever the animation for dropping a new fortune cookie ends.
Source:

handleCookieReady()

A handler called whenever the animation for dropping a new fortune cookie ends.
Source:

handleFortune()

Generates random fortunes. Called when the app finishes analyzing the palm.
Source:

handleFortune()

Generates random fortunes. Called when the app finishes analyzing the palm.
Source:

handleFortuneEnd()

A handler called whenever the animation for opening the fortune cookie ends.
Source:

handleFortuneEnd()

A handler called whenever the animation for opening the fortune cookie ends.
Source:

mod(a, b) → {number}

Calculates the modulus. JavaScript's `%` operator is the remainder operator, which works differently for negative numbers. For example, `-10 % 360` in JavaScript, but `-10 mod 360` is 350.
Parameters:
Name Type Description
a number Dividend
b number Div-sor
Source:
Returns:
The modulus of `a` and `b`
Type
number

mod(a, b) → {number}

Calculates the modulus. JavaScript's `%` operator is the remainder operator, which works differently for negative numbers. For example, `-10 % 360` in JavaScript, but `-10 mod 360` is 350.
Parameters:
Name Type Description
a number Dividend
b number Div-sor
Source:
Returns:
The modulus of `a` and `b`
Type
number

paint()

Draws the next frame of the cookie falling animation.
Source:

paint()

Draws the next frame of the cookie falling animation.
Source:

paintEcg()

Draws the next frame of the fake heartbeat ECG graph animation. Once `frameId` is set to `null`, the animation stops. This should be display refresh rate independent.
Source:

paintEcg()

Draws the next frame of the fake heartbeat ECG graph animation. Once `frameId` is set to `null`, the animation stops. This should be display refresh rate independent.
Source:

pick(options) → {T}

Randomly selects an item in the given list.
Parameters:
Name Type Description
options ArrayLike.<T> List of options to choose from.
Source:
Returns:
The randomly chosen option
Type
T

pick(options) → {T}

Randomly selects an item in the given list.
Parameters:
Name Type Description
options ArrayLike.<T> List of options to choose from.
Source:
Returns:
The randomly chosen option
Type
T

populateVoiceList()

Speech synthesis API, adds options for different voices to read out fortune using voice synthesis
Source:

populateVoiceList()

Speech synthesis API, adds options for different voices to read out fortune using voice synthesis
Source:

prefersReducedMotion() → {boolean}

Determines whether the user has `prefers-reduced-motion` enabled.
Source:
Returns:
Whether to reduce motion.
Type
boolean

prefersReducedMotion() → {boolean}

Determines whether the user has `prefers-reduced-motion` enabled.
Source:
Returns:
Whether to reduce motion.
Type
boolean

randomize()

Handles the randomization process when the "Randomize" button is clicked. Logs the action, selects a random card container, and triggers its animation.
Source:

randomize()

Handles the randomization process when the "Randomize" button is clicked. Logs the action, selects a random card container, and triggers its animation.
Source:

reset(state)

Stops the current animation and resets all animatable parts of the app to the specified view (`state`).
Parameters:
Name Type Description
state 'fortune' | 'cookie' Whether to set the view to showing the fortune (`'fortune'`) or the cookie (`'cookie'`).
Source:

reset(state)

Stops the current animation and resets all animatable parts of the app to the specified view (`state`).
Parameters:
Name Type Description
state 'fortune' | 'cookie' Whether to set the view to showing the fortune (`'fortune'`) or the cookie (`'cookie'`).
Source:

roundAngle(angle) → {number}

Rounds the given angle to the nearest multiple of 30.
Parameters:
Name Type Description
angle number The angle to round.
Source:
Returns:
The rounded angle.
Type
number

roundAngle(angle) → {number}

Rounds the given angle to the nearest multiple of 30.
Parameters:
Name Type Description
angle number The angle to round.
Source:
Returns:
The rounded angle.
Type
number

setInstructions(instruction)

Sets the message that appears under the webcam while it is analyzing the palm. There will be a fade transition between the previous and new instruction message.
Parameters:
Name Type Description
instruction string The message to display. If an empty string, it'll hide the instructions.
Source:

setInstructions(instruction)

Sets the message that appears under the webcam while it is analyzing the palm. There will be a fade transition between the previous and new instruction message.
Parameters:
Name Type Description
instruction string The message to display. If an empty string, it'll hide the instructions.
Source:

speakFortune(fortune)

Reads out the fortune using speech synthesis
Parameters:
Name Type Description
fortune string What the fortune to be read out is
Source:

speakFortune(fortune)

Reads out the fortune using speech synthesis
Parameters:
Name Type Description
fortune string What the fortune to be read out is
Source:

(async) startCamera()

Handler for the "Begin" button that requests for camera access and turns on the webcam.
Source:

(async) startCamera()

Handler for the "Begin" button that requests for camera access and turns on the webcam.
Source:

textGenerator(leftSign, rightSign) → {string}

Generates the text describing the romantic compatibility between two zodiac signs.
Parameters:
Name Type Description
leftSign string The left wheel's zodiac sign.
rightSign string The right wheel's zodiac sign.
Source:
Returns:
The generated text.
Type
string

textGenerator(leftSign, rightSign) → {string}

Generates the text describing the romantic compatibility between two zodiac signs.
Parameters:
Name Type Description
leftSign string The left wheel's zodiac sign.
rightSign string The right wheel's zodiac sign.
Source:
Returns:
The generated text.
Type
string

wait(delay) → {Promise.<void>}

A promise-ified version of `setTimeout`: returns a new `Promise` that resolves after `delay` milliseconds. If the timeout is cancelled, the `Promise` will never resolve.
Parameters:
Name Type Description
delay number The time to wait for in milliseconds.
Source:
Returns:
A new `Promise` that resolves in `delay` milliseconds.
Type
Promise.<void>

wait(delay) → {Promise.<void>}

A promise-ified version of `setTimeout`: returns a new `Promise` that resolves after `delay` milliseconds. If the timeout is cancelled, the `Promise` will never resolve.
Parameters:
Name Type Description
delay number The time to wait for in milliseconds.
Source:
Returns:
A new `Promise` that resolves in `delay` milliseconds.
Type
Promise.<void>

Type Definitions

Defines an entry in the navigation menu.
Type:
  • object
Properties:
Name Type Description
label string The text to show for the link.
i18n string Label for data-i18n for translations.
url string The URL of the page to link to.
imageUrlBase string The URL base of the image icon to show next to the link text.
imageFormats Array.<string> The possible formats for the image icons. This is just appended to the URL base to create valid references. Each string must start with a "." and the array is ordered from highest priority to least priority.
Source:
Defines an entry in the navigation menu.
Type:
  • object
Properties:
Name Type Description
label string The text to show for the link.
i18n string Label for data-i18n for translations.
url string The URL of the page to link to.
imageUrlBase string The URL base of the image icon to show next to the link text.
imageFormats Array.<string> The possible formats for the image icons. This is just appended to the URL base to create valid references. Each string must start with a "." and the array is ordered from highest priority to least priority.
Source:

MomentumInfo

Stores information about the wheel momentum animation.
Type:
  • object
Properties:
Name Type Description
frameId number The ID of the requested frame, returned by `window.requestAnimationFrame`, used to cancel it.
lastTime number The timestamp of the last animation frame.
angleVel number The angular velocity of the wheel, in degrees/ms.
Source:

MomentumInfo

Stores information about the wheel momentum animation.
Type:
  • object
Properties:
Name Type Description
frameId number The ID of the requested frame, returned by `window.requestAnimationFrame`, used to cancel it.
lastTime number The timestamp of the last animation frame.
angleVel number The angular velocity of the wheel, in degrees/ms.
Source:

PointerInfo

Stores information about the pointer dragging the wheel around.
Type:
  • object
Properties:
Name Type Description
pointerId number The ID of the pointer.
initWheelAngle number The angle of the wheel when dragging started.
initMouseAngle number The polar coordinate angle of the mouse when dragging started.
lastMouseAngle2 number The second-to-last recorded mouse angle.
lastTime2 number The timestamp of the second-to-last `pointermove` event.
lastMouseAngle1 number The last recorded mouse angle.
lastTime1 number The timestamp of the last `pointermove` event.
Source:

PointerInfo

Stores information about the pointer dragging the wheel around.
Type:
  • object
Properties:
Name Type Description
pointerId number The ID of the pointer.
initWheelAngle number The angle of the wheel when dragging started.
initMouseAngle number The polar coordinate angle of the mouse when dragging started.
lastMouseAngle2 number The second-to-last recorded mouse angle.
lastTime2 number The timestamp of the second-to-last `pointermove` event.
lastMouseAngle1 number The last recorded mouse angle.
lastTime1 number The timestamp of the last `pointermove` event.
Source:

defaultPreferenceKeyValues

Defines what the preference keys and values are.
Type:
  • object
Properties:
Name Type Description
globalVolume float The globalVolume of all sounds in the web app.
language string The language to display the web app in.
Source:

defaultPreferenceKeyValues

Defines what the preference keys and values are.
Type:
  • object
Properties:
Name Type Description
globalVolume float The globalVolume of all sounds in the web app.
language string The language to display the web app in.
Source: