.. role:: ts-api-decorator

######################
PickOutsideCanvasError
######################

.. container:: ts-api-section

   .. js:class:: PickOutsideCanvasError

      Error object that is thrown when a user attempts to pick from a point outside the viewer canvas.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~PickOutsideCanvasError.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~PickOutsideCanvasError.message`
   * :js:attr:`~PickOutsideCanvasError.name`
   * :js:attr:`~PickOutsideCanvasError.stack`
   * :js:attr:`~PickOutsideCanvasError.prepareStackTrace`
   * :js:attr:`~PickOutsideCanvasError.stackTraceLimit`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~PickOutsideCanvasError.captureStackTrace`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: PickOutsideCanvasError.constructor()



      Creates a new PickOutsideCanvasError


      :rtype: PickOutsideCanvasError



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: PickOutsideCanvasError.message

      :type: string





.. container:: ts-api-section

   .. js:attribute:: PickOutsideCanvasError.name

      :type: string





.. container:: ts-api-section

   .. js:attribute:: PickOutsideCanvasError.stack

      :type: string :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: PickOutsideCanvasError.prepareStackTrace

      :type: function :ts-api-decorator:`optional`

      Optional override for formatting stack traces

      :see: https://v8.dev/docs/stack-trace-api#customizing-stack-traces


      .. js:function:: prepareStackTrace( err, stackTraces)
         :noindex:

         :param err: None
         :type err: Error
         :param stackTraces: None
         :type stackTraces: [CallSite]


         :rtype: any





.. container:: ts-api-section

   .. js:attribute:: PickOutsideCanvasError.stackTraceLimit

      :type: number





Methods
=======

.. rst-class:: ts-api-section

:ts-api-decorator:`static` captureStackTrace
--------------------------------------------

.. js:method:: PickOutsideCanvasError.captureStackTrace( targetObject[, constructorOpt])

   :param targetObject: None
   :type targetObject: object
   :param constructorOpt: :ts-api-decorator:`optional` None
   :type constructorOpt: Function


   Create .stack property on a target object


   :rtype: void

