.. role:: ts-api-decorator

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

.. js:module:: Sc
   :noindex:

.. container:: ts-api-section

   .. js:class:: OverlayInterface



.. container:: api-index-section

   .. rubric:: Methods

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

   * :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
=======

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

destroy
-------

.. js:method:: OverlayInterface.destroy( viewKey, index)

   :param viewKey: None
   :type viewKey: ViewKey
   :param index: None
   :type index: number


   :rtype: void

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

maxIndex
--------

.. js:method:: OverlayInterface.maxIndex()



   :rtype: number

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

setCamera
---------

.. js:method:: OverlayInterface.setCamera( viewKey, index, Camera)

   :param viewKey: None
   :type viewKey: ViewKey
   :param index: None
   :type index: number
   :param Camera: None
   :type Camera: Camera


   :rtype: void

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

setViewport
-----------

.. js:method:: OverlayInterface.setViewport( viewKey, index, anchor, xOffset, xUnit, yOffset, yUnit, width, widthUnit, height, heightUnit)

   :param viewKey: None
   :type viewKey: ViewKey
   :param index: None
   :type index: number
   :param anchor: None
   :type anchor: OverlayAnchor
   :param xOffset: None
   :type xOffset: number
   :param xUnit: None
   :type xUnit: OverlayUnit
   :param yOffset: None
   :type yOffset: number
   :param yUnit: None
   :type yUnit: OverlayUnit
   :param width: None
   :type width: number
   :param widthUnit: None
   :type widthUnit: OverlayUnit
   :param height: None
   :type height: number
   :param heightUnit: None
   :type heightUnit: OverlayUnit


   :rtype: void

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

setVisible
----------

.. js:method:: OverlayInterface.setVisible( viewKey, index, visibility)

   :param viewKey: None
   :type viewKey: ViewKey
   :param index: None
   :type index: number
   :param visibility: None
   :type visibility: boolean


   :rtype: void

