
################
OverlayInterface
################

.. js:class:: Sc.OverlayInterface

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Sc.OverlayInterface.destroy`
   * :js:meth:`~Sc.OverlayInterface.maxIndex`
   * :js:meth:`~Sc.OverlayInterface.setCamera`
   * :js:meth:`~Sc.OverlayInterface.setViewport`
   * :js:meth:`~Sc.OverlayInterface.setVisible`
   
   




Methods
=======

.. js:method:: Sc.OverlayInterface.destroy

   .. rst-class:: sig-pretty-signature
   
      | destroy(**viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`\ , **index**\ : *number*\ ): *void*
   
   **Parameters**
   
      **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`
   
      **index**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Sc.OverlayInterface.maxIndex

   .. rst-class:: sig-pretty-signature
   
      | maxIndex(): *number*
   
   **Returns**\ : *number*
   



.. js:method:: Sc.OverlayInterface.setCamera

   .. rst-class:: sig-pretty-signature
   
      | setCamera(**viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`\ , **index**\ : *number*\ , **Camera**\ : :js:class:`Camera <Sc.Camera>`\ ): *void*
   
   **Parameters**
   
      **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`
   
      **index**\ : *number*
   
      **Camera**\ : :js:class:`Camera <Sc.Camera>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Sc.OverlayInterface.setViewport

   .. rst-class:: sig-pretty-signature
   
      | setViewport(**viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`\ , **index**\ : *number*\ , **anchor**\ : :js:data:`OverlayAnchor <Sc.OverlayAnchor>`\ , **xOffset**\ : *number*\ , **xUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`\ , **yOffset**\ : *number*\ , **yUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`\ , **width**\ : *number*\ , **widthUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`\ , **height**\ : *number*\ , **heightUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`\ ): *void*
   
   **Parameters**
   
      **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`
   
      **index**\ : *number*
   
      **anchor**\ : :js:data:`OverlayAnchor <Sc.OverlayAnchor>`
   
      **xOffset**\ : *number*
   
      **xUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`
   
      **yOffset**\ : *number*
   
      **yUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`
   
      **width**\ : *number*
   
      **widthUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`
   
      **height**\ : *number*
   
      **heightUnit**\ : :js:data:`OverlayUnit <Sc.OverlayUnit>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Sc.OverlayInterface.setVisible

   .. rst-class:: sig-pretty-signature
   
      | setVisible(**viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`\ , **index**\ : *number*\ , **visibility**\ : *boolean*\ ): *void*
   
   **Parameters**
   
      **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`
   
      **index**\ : *number*
   
      **visibility**\ : *boolean*
   
   
   **Returns**\ : *void*
   





