Package com.onshape.api.requests

Class DrawingsCreateTranslationRequest

java.lang.Object

com.onshape.api.requests.DrawingsCreateTranslationRequest

public final class DrawingsCreateTranslationRequest
extends Object

Request object for createTranslation API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DrawingsCreateTranslationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DrawingsCreateTranslationRequest.Builder	builder(Onshape onshape)
String	getColorMethod()	Get (PDF only) The color transformation that should be applied to the drawing on export.
Boolean	getCurrentSheetOnly()	Get (DWG only) Whether to only export the last active sheet or all sheets
String	getDestinationName()	Get Name of the output file or new element.
Boolean	getFlatten()	Get Whether to set z-height to zero and normals to positive
String	getFormatName()	Get Name of format into which this element should be translated.
String	getLinkDocumentWorkspaceId()	Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.
Boolean	getNotifyUser()	Get Whether a user notification should be generated on completion
Boolean	getSelectablePdfText()	Get (PDF only) Controls if text on the drawing should be selectable on the output PDF.
Boolean	getShowOveriddenDimensions()	Get (DWG only) Whether overridden dimensions should be underlined
Boolean	getSplinesAsPolylines()	Get Whether splines should be converted to polylines on the export
Boolean	getStoreInDocument()	Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).
Boolean	getTextAsGeometry()	Get Whether text should be exploded into polylines
String	getVersionString()	Get (DWG only) Version of output format to use (format-dependent).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFormatName

public final String getFormatName()

Get Name of format into which this element should be translated.

Returns:

Name of format into which this element should be translated.

getDestinationName

public final String getDestinationName()

Get Name of the output file or new element. If the name does not include a file extension the extension will be derived from the formatName parameter

Returns:

Name of the output file or new element. If the name does not include a file extension the extension will be derived from the formatName parameter

getVersionString

public final String getVersionString()

Get (DWG only) Version of output format to use (format-dependent). Currently supported formats are: 2013, 2010, 2007, 2004, 2000, R14, R13, R12

Returns:

(DWG only) Version of output format to use (format-dependent). Currently supported formats are: 2013, 2010, 2007, 2004, 2000, R14, R13, R12

getNotifyUser

public final Boolean getNotifyUser()

Get Whether a user notification should be generated on completion

Returns:

Whether a user notification should be generated on completion

getTextAsGeometry

public final Boolean getTextAsGeometry()

Get Whether text should be exploded into polylines

Returns:

Whether text should be exploded into polylines

getShowOveriddenDimensions

public final Boolean getShowOveriddenDimensions()

Get (DWG only) Whether overridden dimensions should be underlined

Returns:

(DWG only) Whether overridden dimensions should be underlined

getCurrentSheetOnly

public final Boolean getCurrentSheetOnly()

Get (DWG only) Whether to only export the last active sheet or all sheets

Returns:

(DWG only) Whether to only export the last active sheet or all sheets

getSplinesAsPolylines

public final Boolean getSplinesAsPolylines()

Get Whether splines should be converted to polylines on the export

Returns:

Whether splines should be converted to polylines on the export

getFlatten

public final Boolean getFlatten()

Get Whether to set z-height to zero and normals to positive

Returns:

Whether to set z-height to zero and normals to positive

getColorMethod

public final String getColorMethod()

Get (PDF only) The color transformation that should be applied to the drawing on export. Supported options are: color, blackandwhite and grayscale

Returns:

(PDF only) The color transformation that should be applied to the drawing on export. Supported options are: color, blackandwhite and grayscale

getSelectablePdfText

public final Boolean getSelectablePdfText()

Get (PDF only) Controls if text on the drawing should be selectable on the output PDF.

Returns:

(PDF only) Controls if text on the drawing should be selectable on the output PDF.

getStoreInDocument

public final Boolean getStoreInDocument()

Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

Returns:

controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

getLinkDocumentWorkspaceId

public final String getLinkDocumentWorkspaceId()

Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.

Returns:

If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final DrawingsCreateTranslationRequest.Builder builder(Onshape onshape)