onshape-cadscript
Preparing search index...
Cad
Interface Cad
interface
Cad
{
front
:
PlaneRef
;
right
:
PlaneRef
;
top
:
PlaneRef
;
bodies
(
feature
:
FeatureRef
)
:
QueryRef
;
boolean
(
options
:
Omit
<
BooleanFeature
,
"kind"
>
)
:
FeatureGenerator
<
"boolean"
>
;
cap
(
feature
:
FeatureRef
,
cap
:
"START"
|
"END"
,
entityType
?:
"FACE"
|
"EDGE"
,
)
:
QueryRef
;
chamfer
(
options
:
Omit
<
ChamferFeature
,
"kind"
>
)
:
FeatureGenerator
<
"chamfer"
>
;
closestTo
(
query
:
QueryRef
,
point
:
Point3
)
:
QueryRef
;
edges
(
feature
:
FeatureRef
)
:
QueryRef
;
extrude
(
options
:
Omit
<
ExtrudeFeature
,
"endBound"
|
"kind"
|
"operation"
|
"bodyType"
,
>
&
Partial
<
Pick
<
ExtrudeFeature
,
"endBound"
|
"operation"
|
"bodyType"
>
>
,
)
:
FeatureGenerator
<
"extrude"
>
;
faces
(
feature
:
FeatureRef
)
:
QueryRef
;
fillet
(
options
:
Omit
<
FilletFeature
,
"kind"
>
)
:
FeatureGenerator
<
"fillet"
>
;
geometry
(
query
:
QueryRef
,
geometry
:
GeometryType
)
:
QueryRef
;
ownedByBody
(
body
:
QueryRef
,
entityType
:
EntityType
)
:
QueryRef
;
plane
(
options
:
Omit
<
PlaneFeature
,
"kind"
>
)
:
FeatureGenerator
<
"plane"
>
;
rawFeature
(
options
:
Omit
<
RawFeature
,
"kind"
>
)
:
FeatureGenerator
<
"raw"
>
;
rawQuery
(
query
:
string
)
:
QueryRef
;
revolve
(
options
:
Omit
<
RevolveFeature
,
"kind"
|
"operation"
|
"revolveType"
>
&
Partial
<
Pick
<
RevolveFeature
,
"operation"
|
"revolveType"
>
,
>
,
)
:
FeatureGenerator
<
"revolve"
>
;
shell
(
options
:
Omit
<
ShellFeature
,
"kind"
>
)
:
FeatureGenerator
<
"shell"
>
;
sketch
(
options
:
Omit
<
SketchFeature
,
"kind"
|
"constraints"
>
&
{
constraints
?:
readonly
SketchConstraint
[]
;
}
,
)
:
FeatureGenerator
<
"sketch"
>
;
sketchEntity
(
sketch
:
FeatureRef
<
"sketch"
>
,
entityId
:
string
,
entityType
?:
EntityType
,
)
:
QueryRef
;
split
(
options
:
Omit
<
SplitFeature
,
"kind"
>
)
:
FeatureGenerator
<
"split"
>
;
transform
(
options
:
Omit
<
TransformFeature
,
"kind"
>
,
)
:
FeatureGenerator
<
"transform"
>
;
vertices
(
feature
:
FeatureRef
)
:
QueryRef
;
}
Index
Properties
front
right
top
Methods
bodies
boolean
cap
chamfer
closest
To
edges
extrude
faces
fillet
geometry
owned
By
Body
plane
raw
Feature
raw
Query
revolve
shell
sketch
sketch
Entity
split
transform
vertices
Properties
Readonly
front
front
:
PlaneRef
Readonly
right
right
:
PlaneRef
Readonly
top
top
:
PlaneRef
Methods
bodies
bodies
(
feature
:
FeatureRef
)
:
QueryRef
Parameters
feature
:
FeatureRef
Returns
QueryRef
boolean
boolean
(
options
:
Omit
<
BooleanFeature
,
"kind"
>
)
:
FeatureGenerator
<
"boolean"
>
Parameters
options
:
Omit
<
BooleanFeature
,
"kind"
>
Returns
FeatureGenerator
<
"boolean"
>
cap
cap
(
feature
:
FeatureRef
,
cap
:
"START"
|
"END"
,
entityType
?:
"FACE"
|
"EDGE"
,
)
:
QueryRef
Parameters
feature
:
FeatureRef
cap
:
"START"
|
"END"
Optional
entityType
:
"FACE"
|
"EDGE"
Returns
QueryRef
chamfer
chamfer
(
options
:
Omit
<
ChamferFeature
,
"kind"
>
)
:
FeatureGenerator
<
"chamfer"
>
Parameters
options
:
Omit
<
ChamferFeature
,
"kind"
>
Returns
FeatureGenerator
<
"chamfer"
>
closest
To
closestTo
(
query
:
QueryRef
,
point
:
Point3
)
:
QueryRef
Parameters
query
:
QueryRef
point
:
Point3
Returns
QueryRef
edges
edges
(
feature
:
FeatureRef
)
:
QueryRef
Parameters
feature
:
FeatureRef
Returns
QueryRef
extrude
extrude
(
options
:
Omit
<
ExtrudeFeature
,
"endBound"
|
"kind"
|
"operation"
|
"bodyType"
,
>
&
Partial
<
Pick
<
ExtrudeFeature
,
"endBound"
|
"operation"
|
"bodyType"
>
>
,
)
:
FeatureGenerator
<
"extrude"
>
Parameters
options
:
Omit
<
ExtrudeFeature
,
"endBound"
|
"kind"
|
"operation"
|
"bodyType"
>
&
Partial
<
Pick
<
ExtrudeFeature
,
"endBound"
|
"operation"
|
"bodyType"
>
,
>
Returns
FeatureGenerator
<
"extrude"
>
faces
faces
(
feature
:
FeatureRef
)
:
QueryRef
Parameters
feature
:
FeatureRef
Returns
QueryRef
fillet
fillet
(
options
:
Omit
<
FilletFeature
,
"kind"
>
)
:
FeatureGenerator
<
"fillet"
>
Parameters
options
:
Omit
<
FilletFeature
,
"kind"
>
Returns
FeatureGenerator
<
"fillet"
>
geometry
geometry
(
query
:
QueryRef
,
geometry
:
GeometryType
)
:
QueryRef
Parameters
query
:
QueryRef
geometry
:
GeometryType
Returns
QueryRef
owned
By
Body
ownedByBody
(
body
:
QueryRef
,
entityType
:
EntityType
)
:
QueryRef
Parameters
body
:
QueryRef
entityType
:
EntityType
Returns
QueryRef
plane
plane
(
options
:
Omit
<
PlaneFeature
,
"kind"
>
)
:
FeatureGenerator
<
"plane"
>
Parameters
options
:
Omit
<
PlaneFeature
,
"kind"
>
Returns
FeatureGenerator
<
"plane"
>
raw
Feature
rawFeature
(
options
:
Omit
<
RawFeature
,
"kind"
>
)
:
FeatureGenerator
<
"raw"
>
Parameters
options
:
Omit
<
RawFeature
,
"kind"
>
Returns
FeatureGenerator
<
"raw"
>
raw
Query
rawQuery
(
query
:
string
)
:
QueryRef
Parameters
query
:
string
Returns
QueryRef
revolve
revolve
(
options
:
Omit
<
RevolveFeature
,
"kind"
|
"operation"
|
"revolveType"
>
&
Partial
<
Pick
<
RevolveFeature
,
"operation"
|
"revolveType"
>
,
>
,
)
:
FeatureGenerator
<
"revolve"
>
Parameters
options
:
Omit
<
RevolveFeature
,
"kind"
|
"operation"
|
"revolveType"
>
&
Partial
<
Pick
<
RevolveFeature
,
"operation"
|
"revolveType"
>
,
>
Returns
FeatureGenerator
<
"revolve"
>
shell
shell
(
options
:
Omit
<
ShellFeature
,
"kind"
>
)
:
FeatureGenerator
<
"shell"
>
Parameters
options
:
Omit
<
ShellFeature
,
"kind"
>
Returns
FeatureGenerator
<
"shell"
>
sketch
sketch
(
options
:
Omit
<
SketchFeature
,
"kind"
|
"constraints"
>
&
{
constraints
?:
readonly
SketchConstraint
[]
;
}
,
)
:
FeatureGenerator
<
"sketch"
>
Parameters
options
:
Omit
<
SketchFeature
,
"kind"
|
"constraints"
>
&
{
constraints
?:
readonly
SketchConstraint
[]
;
}
Returns
FeatureGenerator
<
"sketch"
>
sketch
Entity
sketchEntity
(
sketch
:
FeatureRef
<
"sketch"
>
,
entityId
:
string
,
entityType
?:
EntityType
,
)
:
QueryRef
Parameters
sketch
:
FeatureRef
<
"sketch"
>
entityId
:
string
Optional
entityType
:
EntityType
Returns
QueryRef
split
split
(
options
:
Omit
<
SplitFeature
,
"kind"
>
)
:
FeatureGenerator
<
"split"
>
Parameters
options
:
Omit
<
SplitFeature
,
"kind"
>
Returns
FeatureGenerator
<
"split"
>
transform
transform
(
options
:
Omit
<
TransformFeature
,
"kind"
>
,
)
:
FeatureGenerator
<
"transform"
>
Parameters
options
:
Omit
<
TransformFeature
,
"kind"
>
Returns
FeatureGenerator
<
"transform"
>
vertices
vertices
(
feature
:
FeatureRef
)
:
QueryRef
Parameters
feature
:
FeatureRef
Returns
QueryRef
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
front
right
top
Methods
bodies
boolean
cap
chamfer
closest
To
edges
extrude
faces
fillet
geometry
owned
By
Body
plane
raw
Feature
raw
Query
revolve
shell
sketch
sketch
Entity
split
transform
vertices
onshape-cadscript
Loading...