Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SceneViewTakeScreenshotOptions

Hierarchy

  • Object
    • SceneViewTakeScreenshotOptions

Index

Properties

Optional area

Specifies whether to take a screenshot of a specific area of the view.

Read more...

constructor

constructor: Function

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Optional format

format: "png" | "jpg"

The format of the resulting encoded data url.

Read more...

Optional height

height: number

The height of the screenshot (defaults to the area height).

Read more...

Optional ignorePadding

ignorePadding: boolean

Indicates whether view padding should be ignored.

Read more...

Optional quality

quality: number

The quality (0 to 100) of the encoded image when format is jpg.

Read more...

Optional width

width: number

The width of the screenshot (defaults to the area width).

Read more...

Methods

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object
  • Returns the primitive value of the specified object.

    Returns Object

Generated using TypeDoc