PDFTron pdfnet-node

Class: SVGConvertOptions

PDFNet.Convert. SVGConvertOptions

new SVGConvertOptions()

Options for PDFNet.Convert.fromSVG

Methods

Gets the value ConvertLinks from the options object Instructs the conversion process to generate interactive Link annotations from links in the SVG input file.
Returns:
the current value for ConvertLinks.
Type
boolean

getDefaultFontFamily()

Gets the value DefaultFontFamily from the options object Name of the font family which is used if a font for some text in the graphics file is either not specified or not available. Default: Arial Unicode MS if available, otherwise Helvetica.
Returns:
the current value for DefaultFontFamily.
Type
string

getFallbackFontFamily()

Gets the value FallbackFontFamily from the options object Name of the font family which is used to create a fallback font for each font, in addition to the fallback fonts which may have been specified in the graphics file. Default: empty.
Returns:
the current value for FallbackFontFamily.
Type
string

getFallbackHeight()

Gets the value FallbackHeight from the options object Affects only SVG graphics without absolute size; ignored if ForcedHeight is supplied. Height >= 0 of the SVG graphics for the fitting process. If the value is zero the bounding box is calculated. Default: values in the SVG graphics if present, otherwise 0.
Returns:
the current value for FallbackHeight.
Type
number

getFallbackWidth()

Gets the value FallbackWidth from the options object Affects only SVG graphics without absolute size; ignored if ForcedWidth is supplied. Width >= 0 of the SVG graphics for the fitting process. If the value is zero the bounding box is calculated. Default: values in the SVG graphics if present, otherwise 0.
Returns:
the current value for FallbackWidth.
Type
number

getForcedHeight()

Gets the value ForcedHeight from the options object The height of the SVG graphics is ignored and the specified value is applied instead if a value >= 1 is supplied. Default: height attribute of the graphics.
Returns:
the current value for ForcedHeight.
Type
number

getForcedWidth()

Gets the value ForcedWidth from the options object The width of the SVG graphics is ignored and the specified value is applied instead if a value >= 1 is supplied. Default: width attribute of the graphics.
Returns:
the current value for ForcedWidth.
Type
number

getForceSRGB()

Gets the value ForceSRGB from the options object If true, all non-sRGB color specifications are ignored and the sRGB fallback color is used instead. This option does not affect referenced images. Default: false.
Returns:
the current value for ForceSRGB.
Type
boolean

getHonorIccProfile()

Gets the value HonorIccProfile from the options object If true, honor all ICC profiles in icc-color specifications or implicitly in sRGB colors; otherwise all explicit ICC colors and implicit sRGB colors are interpreted as device-gray/device-rgb/device-cmyk colors. Default: true.
Returns:
the current value for HonorIccProfile.
Type
boolean

getInline()

Gets the value Inline from the options object If true, create output inline in the content stream; otherwise a separate Form XObject is created. The inline method suffers from disadvantages related to transparency handling. On the other hand, this option is required if active links in the graphics should be converted (option ConvertLinks). Default: true.
Returns:
the current value for Inline.
Type
boolean

getLang()

Gets the value Lang from the options object Natural language for the graphics file as a BCP 47 language tag consisting of a two- or three-character language code according to ISO 639-1/2 which can be used e.g. in an SVG switch element. Default: the language identifier found in the LANG environment variable.
Returns:
the current value for Lang.
Type
string
Sets the value for ConvertLinks in the options object Instructs the conversion process to generate interactive Link annotations from links in the SVG input file.
Parameters:
Name Type Description
value boolean the new value for ConvertLinks
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setDefaultFontFamily(value)

Sets the value for DefaultFontFamily in the options object Name of the font family which is used if a font for some text in the graphics file is either not specified or not available. Default: Arial Unicode MS if available, otherwise Helvetica.
Parameters:
Name Type Description
value string the new value for DefaultFontFamily
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setFallbackFontFamily(value)

Sets the value for FallbackFontFamily in the options object Name of the font family which is used to create a fallback font for each font, in addition to the fallback fonts which may have been specified in the graphics file. Default: empty.
Parameters:
Name Type Description
value string the new value for FallbackFontFamily
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setFallbackHeight(value)

Sets the value for FallbackHeight in the options object Affects only SVG graphics without absolute size; ignored if ForcedHeight is supplied. Height >= 0 of the SVG graphics for the fitting process. If the value is zero the bounding box is calculated. Default: values in the SVG graphics if present, otherwise 0.
Parameters:
Name Type Description
value number the new value for FallbackHeight
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setFallbackWidth(value)

Sets the value for FallbackWidth in the options object Affects only SVG graphics without absolute size; ignored if ForcedWidth is supplied. Width >= 0 of the SVG graphics for the fitting process. If the value is zero the bounding box is calculated. Default: values in the SVG graphics if present, otherwise 0.
Parameters:
Name Type Description
value number the new value for FallbackWidth
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setForcedHeight(value)

Sets the value for ForcedHeight in the options object The height of the SVG graphics is ignored and the specified value is applied instead if a value >= 1 is supplied. Default: height attribute of the graphics.
Parameters:
Name Type Description
value number the new value for ForcedHeight
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setForcedWidth(value)

Sets the value for ForcedWidth in the options object The width of the SVG graphics is ignored and the specified value is applied instead if a value >= 1 is supplied. Default: width attribute of the graphics.
Parameters:
Name Type Description
value number the new value for ForcedWidth
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setForceSRGB(value)

Sets the value for ForceSRGB in the options object If true, all non-sRGB color specifications are ignored and the sRGB fallback color is used instead. This option does not affect referenced images. Default: false.
Parameters:
Name Type Description
value boolean the new value for ForceSRGB
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setHonorIccProfile(value)

Sets the value for HonorIccProfile in the options object If true, honor all ICC profiles in icc-color specifications or implicitly in sRGB colors; otherwise all explicit ICC colors and implicit sRGB colors are interpreted as device-gray/device-rgb/device-cmyk colors. Default: true.
Parameters:
Name Type Description
value boolean the new value for HonorIccProfile
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setInline(value)

Sets the value for Inline in the options object If true, create output inline in the content stream; otherwise a separate Form XObject is created. The inline method suffers from disadvantages related to transparency handling. On the other hand, this option is required if active links in the graphics should be converted (option ConvertLinks). Default: true.
Parameters:
Name Type Description
value boolean the new value for Inline
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions

setLang(value)

Sets the value for Lang in the options object Natural language for the graphics file as a BCP 47 language tag consisting of a two- or three-character language code according to ISO 639-1/2 which can be used e.g. in an SVG switch element. Default: the language identifier found in the LANG environment variable.
Parameters:
Name Type Description
value string the new value for Lang
Returns:
this object, for call chaining
Type
PDFNet.Convert.SVGConvertOptions