PDFTron pdfnet-node

Class: CADConvertOptions

PDFNet.Convert. CADConvertOptions

new CADConvertOptions()

Options for PDFNet.Convert.fromCAD.

Members

<static> LayoutSortOrder

Layout sorting options
Type:
  • number
Properties:
Name Type Description
e_default_order number Default sort order. In this case there is no explicit sort performed, and pages are placed in the order they are encountered in the source document
e_alphabetic_order number Alphabetic sort order
e_alphanumeric_order number Alphanumeric sort order (also called natural sort order)

Methods

getAllowThinLines()

Gets the value AllowThinLines from the options object Sets drawing line weights to zero
Returns:
the current value for AllowThinLines.
Type
boolean

getAutoRotate()

Gets the value AutoRotate from the options object Maps the orientation to the sheet dimensions
Returns:
the current value for AutoRotate.
Type
boolean

getBackgroundColor()

Gets the value BackgroundColor from the options object Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)
Returns:
the current value for BackgroundColor, in form {R: number, G: number, B: number}.
Type
object

getColorMode()

Gets the value ColorMode from the options object Sets the color palette used by the drawing export. Possible values are Mono (i.e., monochrome) and Gray (i.e., grayscale), otherwise drawing's original palette is used
Returns:
the current value for ColorMode.
Type
string

getIncludeModel()

Gets the value IncludeModel from the options object Instructs the conversion process to include the model layout (default: true). Note that if the model layout is empty, it will never be included in the output
Returns:
the current value for IncludeModel.
Type
boolean

getLayoutSortOrder()

Gets the value LayoutSortOrder from the options object Specifies how the layout is sorted during cad to pdf conversion. This affects how each layout is inserted into the output pdf (each layout becomes a pdf page).
Returns:
the current value for LayoutSortOrder.
Type
number
Example
Return value:
<pre>
PDFNet.Convert.CADConvertOptions.LayoutSortOrder = {
 e_default_order : 0
 e_alphabetic_order : 1
 e_alphanumeric_order : 2
}
</pre>

getMaxXrefDepth()

Gets the value MaxXrefDepth from the options object Maximum resolution depth for nested xrefs. Root drawing starts at level 0, subsequent nested levels increment by 1. Nested xrefs at levels greater than specified will not be loaded.
Returns:
the current value for MaxXrefDepth.
Type
number

getPageHeight()

Gets the value PageHeight from the options object The height of the output pdf, in millimeters
Returns:
the current value for PageHeight.
Type
number

getPageWidth()

Gets the value PageWidth from the options object The width of the output pdf, in millimeters
Returns:
the current value for PageWidth.
Type
number

getRasterDPI()

Gets the value RasterDPI from the options object Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions
Returns:
the current value for RasterDPI.
Type
number

getUnderlineTextDataFields()

Gets the value UnderlineTextDataFields from the options object If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.
Returns:
the current value for UnderlineTextDataFields.
Type
boolean

getUseScaleFromDocument()

Gets the value UseScaleFromDocument from the options object If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm. Paper size dimensions are clamped at 5080 mm, and are rescaled if coordinate ranges exceed 5080 mm. Disabled by default.
Returns:
the current value for UseScaleFromDocument.
Type
boolean

getZoomToExtents()

Gets the value ZoomToExtents from the options object If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default.
Returns:
the current value for ZoomToExtents.
Type
boolean

setAllowThinLines(value)

Sets the value for AllowThinLines in the options object Sets drawing line weights to zero
Parameters:
Name Type Description
value boolean The new value for AllowThinLines
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setAutoRotate(value)

Sets the value for AutoRotate in the options object Maps the orientation to the sheet dimensions
Parameters:
Name Type Description
value boolean The new value for AutoRotate
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setBackgroundColor(value)

Sets the value for BackgroundColor in the options object Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)
Parameters:
Name Type Description
value object The new value for BackgroundColor, in form {R: number, G: number, B: number}.
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setColorMode(value)

Sets the value for ColorMode in the options object Sets the color palette used by the drawing export. Possible values are Mono (i.e., monochrome) and Gray (i.e., grayscale), otherwise drawing's original palette is used
Parameters:
Name Type Description
value string The new value for ColorMode
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setIncludeModel(value)

Sets the value for IncludeModel in the options object Instructs the conversion process to include the model layout (default: true). Note that if the model layout is empty, it will never be included in the output
Parameters:
Name Type Description
value boolean The new value for IncludeModel
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setLayoutSortOrder(value)

Sets the value for LayoutSortOrder in the options object Specifies how the layout is sorted during cad to pdf conversion. This affects how each layout is inserted into the output pdf (each layout becomes a pdf page).
Parameters:
Name Type Description
value number The new value for LayoutSortOrder 
PDFNet.Convert.CADConvertOptions.LayoutSortOrder = {
 e_default_order : 0
 e_alphabetic_order : 1
 e_alphanumeric_order : 2
}
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setMaxXrefDepth(value)

Sets the value for MaxXrefDepth in the options object Maximum resolution depth for nested xrefs. Root drawing starts at level 0, subsequent nested levels increment by 1. Nested xrefs at levels greater than specified will not be loaded.
Parameters:
Name Type Description
value number The new value for MaxXrefDepth
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setPageHeight(value)

Sets the value for PageHeight in the options object The height of the output pdf, in millimeters
Parameters:
Name Type Description
value number The new value for PageHeight
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setPageWidth(value)

Sets the value for PageWidth in the options object The width of the output pdf, in millimeters
Parameters:
Name Type Description
value number The new value for PageWidth
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setRasterDPI(value)

Sets the value for RasterDPI in the options object Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions
Parameters:
Name Type Description
value number The new value for RasterDPI
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setSheets(value)

Adds Sheets to the Sheets array The list of sheets to be converted -- only applies to .rvt conversions
Parameters:
Name Type Description
value string The new Sheets to be added to Sheets
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setUnderlineTextDataFields(value)

Sets the value for UnderlineTextDataFields in the options object If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.
Parameters:
Name Type Description
value boolean The new value for UnderlineTextDataFields
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setUseScaleFromDocument(value)

Sets the value for UseScaleFromDocument in the options object If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm. Paper size dimensions are clamped at 5080 mm, and are rescaled if coordinate ranges exceed 5080 mm. Disabled by default.
Parameters:
Name Type Description
value boolean The new value for UseScaleFromDocument
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions

setZoomToExtents(value)

Sets the value for ZoomToExtents in the options object If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default.
Parameters:
Name Type Description
value boolean The new value for ZoomToExtents
Returns:
This object, for call chaining
Type
PDFNet.Convert.CADConvertOptions