.. role:: ts-api-decorator

#########
SvgConfig
#########

.. container:: ts-api-section

   .. js:class:: SvgConfig

      Allows customization of an exported SVG.



.. container:: api-index-section

   .. rubric:: Constructors

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

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



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~SvgConfig.linesClipProximityToPlane`
   * :js:attr:`~SvgConfig.linesClipZNudgeFactor`
   * :js:attr:`~SvgConfig.linesCssColor`
   * :js:attr:`~SvgConfig.linesDrawModelLinesEnabled`
   * :js:attr:`~SvgConfig.linesStrokeWidth`
   * :js:attr:`~SvgConfig.logDiagnostics`
   * :js:attr:`~SvgConfig.logProgress`
   * :js:attr:`~SvgConfig.polygonsForceDrawCssColor`
   * :js:attr:`~SvgConfig.silhouettesEnabled`
   * :js:attr:`~SvgConfig.svgBackgroundCssColor`
   * :js:attr:`~SvgConfig.svgXmlPrologEnabled`





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

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

.. container:: ts-api-section

   .. js:function:: SvgConfig.constructor()



      :rtype: SvgConfig



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: SvgConfig.linesClipProximityToPlane

      :type: number

      For line clipping, this factor determines how close a line can get to a triangle
      without getting clipped. Larger values will help small sections that shouldn't
      get clipped, but larger values may also allow hidden line sections to poke through.
      Z values are normalized to -32767 to 32767, so this value is relative to that scale. (default: 5.5)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.linesClipZNudgeFactor

      :type: number

      For line clipping, this value will be used to adjust line segment endpoints, bringing
      closer to the camera for positive values. This is helpful for z-fighting causing
      small sections of lines to be unintentionally clipped.
      Z values are normalized to -32767 to 32767, so this value is relative to that scale. (default: 5.5)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.linesCssColor

      :type: string

      CSS compliant color string used to draw lines (default: "#000000")



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.linesDrawModelLinesEnabled

      :type: boolean

      Determines if the model lines will be included in the SVG output (default: true)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.linesStrokeWidth

      :type: number

      Determines the output SVG line width for all lines in the model. This is relative to
      the SVG viewBox settings of -32767 to +32767 in both X and Y directions. (default: 20.0)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.logDiagnostics

      :type: boolean

      Enables diagnostics logging. If running in-browser, this will go to the developer console (default: false)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.logProgress

      :type: boolean

      Enables progress logging. If running in-browser, this will go to the developer console (default: false)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.polygonsForceDrawCssColor

      :type: string

      If set to a non-empty CSS string value, forces all polygons to be drawn as this color
      Example, to force all polygons to be white, use <code>PolygonsForceDrawColor="#ffffff"</code>
      (default: "")



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.silhouettesEnabled

      :type: boolean

      Determines if silhouette lines will be drawn for the model (default: true)



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.svgBackgroundCssColor

      :type: string

      If non-empty, an SVG <rect> element will be at the root with the given background color. (default: "")



.. container:: ts-api-section

   .. js:attribute:: SvgConfig.svgXmlPrologEnabled

      :type: boolean

      If true, the standard XML prolog will be included in the output SVG (default: true)



