kigadgets.via
=============

.. py:module:: kigadgets.via


Classes
-------

.. autoapisummary::

   kigadgets.via.ViaType
   kigadgets.via.Via


Module Contents
---------------

.. py:class:: ViaType

   .. py:attribute:: Through


   .. py:attribute:: Micro


   .. py:attribute:: Blind


.. py:class:: Via(center: kigadgets.units.CoordinateLike, size: Optional[float] = None, drill: Optional[float] = None, layer_pair: Optional[List[str]] = None, board: Optional[Board] = None)

   Bases: :py:obj:`kigadgets.item.HasPosition`, :py:obj:`kigadgets.item.HasConnection`, :py:obj:`kigadgets.item.Selectable`, :py:obj:`kigadgets.item.BoardItem`

   .. autoapi-inheritance-diagram:: kigadgets.via.Via
      :parts: 1


   Careful setting top_layer, then getting top_layer may
   return different values if the new top_layer is below the existing bottom layer


   .. py:property:: center
      :type: kigadgets.Point


      Via center


   .. py:property:: size
      :type: float


      Via diameter


   .. py:property:: drill
      :type: float


      Via drill diameter


   .. py:property:: is_through
      :type: bool


      Returns False if it's a blind via OR microvia.


   .. py:attribute:: width


   .. py:attribute:: diameter


   .. py:method:: set_layer_pair(layer_pair: Union[Tuple[str, str], List[str]]) -> None


   .. py:method:: get_layer_pair_hash() -> int


   .. py:property:: top_layer
      :type: str



   .. py:property:: bottom_layer
      :type: str



   .. py:method:: geohash() -> int


   .. py:property:: position
      :type: kigadgets.Point



   .. py:property:: x
      :type: float



   .. py:property:: y
      :type: float



   .. py:property:: net_name
      :type: str



   .. py:property:: net_code
      :type: int



   .. py:property:: is_selected
      :type: bool



   .. py:method:: select(value: bool = True) -> None

      Selecting changes the appearance and also plays a role in determining
      what will be the subject of a subsequent command (delete, move to layer, etc.)



   .. py:method:: deselect() -> None


   .. py:method:: brighten(value: bool = True) -> None

      Brightening gives a bright green appearance



   .. py:property:: native_obj
      :type: Any



   .. py:property:: board
      :type: Optional[kigadgets.board.Board]



   .. py:method:: wrap(instance: Any) -> BoardItem
      :classmethod: