.. role:: ts-api-decorator

#################
LoadSubtreeConfig
#################

.. container:: ts-api-section

   .. js:class:: LoadSubtreeConfig

      Configuration for all ``loadSubtree`` functions in the [[Model]] class.



.. container:: api-index-section

   .. rubric:: Constructors

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

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



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~LoadSubtreeConfig.additionalMatrix`
   * :js:attr:`~LoadSubtreeConfig.allowMissingExternalModels`
   * :js:attr:`~LoadSubtreeConfig.attachInvisibly`
   * :js:attr:`~LoadSubtreeConfig.ignoreBimRelationships`
   * :js:attr:`~LoadSubtreeConfig.ignoreCadViews`
   * :js:attr:`~LoadSubtreeConfig.ignoreFilters`
   * :js:attr:`~LoadSubtreeConfig.ignoreGenericTypes`
   * :js:attr:`~LoadSubtreeConfig.ignoreLayers`
   * :js:attr:`~LoadSubtreeConfig.implicitlyLoadXmlExternalModels`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~LoadSubtreeConfig.copy`





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

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

.. container:: ts-api-section

   .. js:function:: LoadSubtreeConfig.constructor()



      :rtype: LoadSubtreeConfig



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.additionalMatrix

      :type: null | Matrix

      Optional matrix to get multiplied into the net attachment matrix.



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.allowMissingExternalModels

      :type: boolean

      Controls whether or not missing models are ignored or cause an error.



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.attachInvisibly

      :type: boolean

      If true, then models are attached with all geometry turned invisible.



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.ignoreBimRelationships

      :type: boolean

      If true BIM relationships will not be loaded. This can reduce memory consumption



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.ignoreCadViews

      :type: boolean

      If true CAD views will not be loaded. This can reduce memory consumption



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.ignoreFilters

      :type: boolean

      If true filters will not be loaded. This can reduce memory consumption



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.ignoreGenericTypes

      :type: boolean

      If true generic types (IFC types) will not be loaded. This can reduce memory consumption



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.ignoreLayers

      :type: boolean

      If true layers will not be loaded. This can reduce memory consumption



.. container:: ts-api-section

   .. js:attribute:: LoadSubtreeConfig.implicitlyLoadXmlExternalModels

      :type: boolean

      If true, then external models found in XML files will be implicitly loaded.
      Otherwise [[Model.requestNodes]] must be called to load the external models.



Methods
=======

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

copy
----

.. js:method:: LoadSubtreeConfig.copy()



   :rtype: LoadSubtreeConfig

