Interface: ForceElementSizeOptions

An object describing customization for the force body feature.

Hierarchy

• ForceElementSizeOptions

Properties

forceHeight

• Optional forceHeight: boolean

Force body height to heightValue.

defaultvalue true

---

forceWidth

• Optional forceWidth: boolean

Force body width to widthValue.

defaultvalue true

---

heightValue

• Optional heightValue: number | string

The height to override.

defaultvalue 'auto'

---

shouldThrowWhenNotFound

• Optional shouldThrowWhenNotFound: boolean

When no element is found matching the target, should the script raise an error?

defaultvalue false

---

target

• Optional target: DOMElementRequest

The element to target.

defaultvalue 'body'

---

widthValue

• Optional widthValue: number | string

The width to override.

defaultvalue 'auto'