CadOptions - GroupDocs.Viewer for Java

Packages

java.lang.Object
- com.groupdocs.viewer.options.CadOptions

```
public class CadOptions
extends Object
```
Provides options for rendering CAD drawings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CadOptions`	`forRenderingByHeight(int height)` Initializes new instance of `CadOptions` class for rendering by height.
`static CadOptions`	`forRenderingByScaleFactor(float scaleFactor)` Initializes new instance of `CadOptions` class for rendering by scale factor.
`static CadOptions`	`forRenderingByWidth(int width)` Initializes new instance of `CadOptions` class for rendering by width.
`static CadOptions`	`forRenderingByWidthAndHeight(int width, int height)` Initializes new instance of `CadOptions` class for rendering by width and height.
`Color`	`getBackgroundColor()` Gets image background color
`int`	`getHeight()` The height of the output result in pixels.
`List<Layer>`	`getLayers()` The CAD drawing layers to render.
`String`	`getLayoutName()` The name of the specific layout to render.
`String`	`getPc3File()` PC3 - plotter configuration file
`float`	`getScaleFactor()` Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller.
`List<Tile>`	`getTiles()` The drawing regions to render.
`int`	`getWidth()` The width of the output result in pixels.
`boolean`	`isRenderLayouts()` Indicates whether layouts from CAD document should be rendered.
`void`	`setBackgroundColor(Color mBackgroundColor)` Sets image background color
`void`	`setLayers(List<Layer> value)` The CAD drawing layers to render.
`void`	`setLayoutName(String value)` The name of the specific layout to render.
`void`	`setPc3File(String pc3File)` PC3 - plotter configuration file
`void`	`setRenderLayouts(boolean value)` Indicates whether layouts from CAD document should be rendered.
`void`	`setTiles(List<Tile> value)` The drawing regions to render.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - forRenderingByHeight
```
public static CadOptions forRenderingByHeight(int height)
```
    Initializes new instance of CadOptions class for rendering by height.
    
    Parameters:
    
    height - The height of the output result in pixels.
    
    Returns:
    
    New instance of CadOptions class for rendering by height.
    
    Throws:
    
    IllegalArgumentException - Thrown when height is less or equal to zero.
  - forRenderingByScaleFactor
```
public static CadOptions forRenderingByScaleFactor(float scaleFactor)
```
    Initializes new instance of CadOptions class for rendering by scale factor.
    
    Parameters:
    
    scaleFactor - Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller.
    
    Returns:
    
    New instance of CadOptions class for rendering by scale factor.
  - forRenderingByWidth
```
public static CadOptions forRenderingByWidth(int width)
```
    Initializes new instance of CadOptions class for rendering by width.
    
    Parameters:
    
    width - The width of the output result in pixels.
    
    Returns:
    
    New instance of CadOptions class for rendering by width.
    
    Throws:
    
    IllegalArgumentException - Thrown when width is less or equal to zero.
  - forRenderingByWidthAndHeight
```
public static CadOptions forRenderingByWidthAndHeight(int width,
                                                      int height)
```
    Initializes new instance of CadOptions class for rendering by width and height.
    
    Parameters:
    
    width - The width of the output result in pixels.
    
    height - The height of the output result in pixels.
    
    Returns:
    
    New instance of CadOptions class for rendering by width and height.
    
    Throws:
    
    IllegalArgumentException - Thrown when width is less or equal to zero.
    
    IllegalArgumentException - Thrown when height is less or equal to zero.
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Gets image background color
    
    Returns:
    
    Image background color
  - getHeight
```
public final int getHeight()
```
    The height of the output result in pixels.
  - getLayers
```
public final List<Layer> getLayers()
```
    The CAD drawing layers to render.
    By default all layers are rendered; Layer names are case-sensitive.
  - getLayoutName
```
public final String getLayoutName()
```
    The name of the specific layout to render. Layout name is case-sensitive.
    This option applies only to CAD drawings that support layouts FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF and FileType.DWFX; By default only Model is rendered.
  - getPc3File
```
public String getPc3File()
```
    PC3 - plotter configuration file
  - getScaleFactor
```
public final float getScaleFactor()
```
    Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller.
  - getTiles
```
public final List<Tile> getTiles()
```
    The drawing regions to render.
    This option supported only for FileType.DWG and FileType.DWT file type. The RenderLayouts(isRenderLayouts()/setRenderLayouts(boolean)) and LayoutName(getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.
  - getWidth
```
public final int getWidth()
```
    The width of the output result in pixels.
  - isRenderLayouts
```
public final boolean isRenderLayouts()
```
    Indicates whether layouts from CAD document should be rendered.
    This option applies only to CAD drawings that support layouts FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF and FileType.DWFX; By default only Model is rendered.
  - setBackgroundColor
```
public void setBackgroundColor(Color mBackgroundColor)
```
    Sets image background color
    
    Parameters:
    
    mBackgroundColor - Image background color
  - setLayers
```
public final void setLayers(List<Layer> value)
```
    The CAD drawing layers to render.
    By default all layers are rendered; Layer names are case-sensitive.
  - setLayoutName
```
public final void setLayoutName(String value)
```
    The name of the specific layout to render. Layout name is case-sensitive.
    This option applies only to CAD drawings that support layouts FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF and FileType.DWFX; By default only Model is rendered.
  - setPc3File
```
public void setPc3File(String pc3File)
```
    PC3 - plotter configuration file
  - setRenderLayouts
```
public final void setRenderLayouts(boolean value)
```
    Indicates whether layouts from CAD document should be rendered.
    This option applies only to CAD drawings that support layouts FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF and FileType.DWFX; By default only Model is rendered.
  - setTiles
```
public final void setTiles(List<Tile> value)
```
    The drawing regions to render.
    This option supported only for FileType.DWG and FileType.DWT file type. The RenderLayouts(isRenderLayouts()/setRenderLayouts(boolean)) and LayoutName(getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.

Packages

com.groupdocs.viewer.options

Interfaces

Classes

Enums

Class CadOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forRenderingByHeight

forRenderingByScaleFactor

forRenderingByWidth

forRenderingByWidthAndHeight

getBackgroundColor

getHeight

getLayers

getLayoutName

getPc3File

getScaleFactor

getTiles

getWidth

isRenderLayouts

setBackgroundColor

setLayers

setLayoutName

setPc3File

setRenderLayouts

setTiles