Documentation / @ripl/core / FactoryOptions

Interface: FactoryOptions

Defined in: packages/core/src/core/factory.ts:9

Platform-specific function implementations injected at runtime.

Properties

Property	Type	Description	Defined in
devicePixelRatio	number	The ratio of physical pixels to CSS pixels for the current display.	packages/core/src/core/factory.ts:17

Methods

cancelAnimationFrame()

cancelAnimationFrame(handle): void

Defined in: packages/core/src/core/factory.ts:13

Cancels a frame request previously scheduled via FactoryOptions.requestAnimationFrame.

Parameters

Parameter	Type
handle	number

Returns

void

---

createContext()

createContext(target, options?): Context

Defined in: packages/core/src/core/factory.ts:24

Creates a rendering Context bound to the given target selector or element.

Parameters

Parameter	Type
target	string | HTMLElement
options?	ContextOptions<Record<string, unknown>>

Returns

Context

---

createElement()

createElement(tagName): HTMLElement

Defined in: packages/core/src/core/factory.ts:26

Creates a DOM element with the given tag name.

Parameters

Parameter	Type
tagName	string

Returns

HTMLElement

---

createElementNS()

createElementNS(namespace, tagName): Element

Defined in: packages/core/src/core/factory.ts:28

Creates a namespaced DOM element (e.g. SVG) with the given namespace URI and tag name.

Parameters

Parameter	Type
namespace	string
tagName	string

Returns

Element

---

getComputedStyle()

getComputedStyle(element): object

Defined in: packages/core/src/core/factory.ts:19

Returns the computed style for the given element, exposing at least its resolved font shorthand.

Parameters

Parameter	Type
element	unknown

Returns

font

font: string

The element's resolved CSS font shorthand.

---

getDefaultState()

getDefaultState(): BaseState

Defined in: packages/core/src/core/factory.ts:30

Returns a fresh copy of the platform's default BaseState.

Returns

BaseState

---

measureText()

measureText(text, options?): TextMetrics

Defined in: packages/core/src/core/factory.ts:32

Measures the given text, returning its TextMetrics.

Parameters

Parameter	Type
text	string
options?	MeasureTextOptions

Returns

TextMetrics

---

now()

now(): number

Defined in: packages/core/src/core/factory.ts:15

Returns the current high-resolution time, in milliseconds.

Returns

number

---

requestAnimationFrame()

requestAnimationFrame(callback): number

Defined in: packages/core/src/core/factory.ts:11

Schedules callback to run before the next repaint, returning a handle used to cancel it.

Parameters

Parameter	Type
callback	FrameRequestCallback

Returns

number