G-code Preview — API Reference
Guide
npm
GitHub
Preparing search index...
@chestnutlabs/gcode-preview-vue
GcodePreview
Variable GcodePreview
Const
GcodePreview
:
DefineComponent
<
ExtractPropTypes
<
{
adjacentLayers
:
{
default
:
undefined
;
type
:
PropType
<
number
>
}
;
buildVolume
:
{
default
:
undefined
;
type
:
PropType
<
BuildVolumeDef
|
MachineGeometry
>
;
}
;
cameraMode
:
{
default
:
string
;
type
:
PropType
<
CameraMode
>
}
;
cameraState
:
{
default
:
undefined
;
type
:
PropType
<
null
|
CameraState
>
}
;
colorMode
:
{
default
:
undefined
;
type
:
PropType
<
ColorMode
>
}
;
createWorker
:
{
default
:
undefined
;
type
:
PropType
<
()
=>
WorkerLike
>
}
;
frameContent
:
{
default
:
string
;
type
:
PropType
<
"object"
|
"all"
>
}
;
hiddenFeatureRoles
:
{
default
:
undefined
;
type
:
PropType
<
FeatureRoleValue
[]
>
;
}
;
interactionQuality
:
{
default
:
string
;
type
:
PropType
<
"auto"
|
"off"
>
}
;
layerRange
:
{
default
:
null
;
type
:
PropType
<
null
|
[
number
,
number
]
>
}
;
parseOptions
:
{
default
:
undefined
;
type
:
PropType
<
WireParseOptions
>
}
;
progress
:
{
default
:
null
;
type
:
PropType
<
null
|
ProgressObservation
>
}
;
progressivePreview
:
{
default
:
undefined
;
type
:
PropType
<
ProgressivePreview
>
;
}
;
quality
:
{
default
:
string
;
type
:
PropType
<
QualityMode
|
"auto"
>
}
;
qualityMode
:
{
default
:
undefined
;
type
:
PropType
<
QualityPolicy
>
}
;
renderer
:
{
default
:
undefined
;
type
:
PropType
<
RendererMode
>
}
;
rendererOptions
:
{
default
:
undefined
;
type
:
PropType
<
Omit
<
{
adjacentLayers
?:
number
;
buildVolume
?:
BuildVolumeDef
;
cameraMode
?:
CameraMode
;
chunksPerTick
?:
number
;
colorMode
?:
ColorMode
;
createRenderer
?:
(
canvas
:
RenderTargetCanvas
)
=>
GLRendererLike
;
frameContent
?:
"object"
|
"all"
;
geometryConcurrency
?:
number
|
"auto"
|
"off"
;
geometryMemoryBudgetBytes
?:
number
;
ghostOpacity
?:
number
;
interactionQuality
?:
"auto"
|
"off"
;
mode
?:
RendererMode
;
progressivePreview
?:
ProgressivePreview
;
quality
?:
QualityMode
|
"auto"
;
qualityMode
?:
QualityPolicy
;
scheduleFrame
?:
(
cb
:
()
=>
void
)
=>
void
;
theme
?:
Theme
;
tube
?:
TubeOptions
;
}
,
|
"buildVolume"
|
"quality"
|
"qualityMode"
|
"progressivePreview"
|
"cameraMode"
|
"frameContent"
|
"interactionQuality"
|
"theme"
|
"colorMode"
|
"tube"
,
>
,
>
;
}
;
scrub
:
{
default
:
null
;
type
:
PropType
<
null
|
number
>
}
;
scrubTime
:
{
default
:
null
;
type
:
PropType
<
null
|
number
>
}
;
showRetractions
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
showTravel
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
showVolumeCage
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
showWipe
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
source
:
{
default
:
null
;
type
:
PropType
<
GcodePreviewSource
>
}
;
theme
:
{
default
:
undefined
;
type
:
PropType
<
Theme
>
}
;
tube
:
{
default
:
undefined
;
type
:
PropType
<
TubeOptions
>
}
;
view
:
{
default
:
undefined
;
type
:
PropType
<
CameraView
>
}
;
}
,
>
,
()
=>
VNode
<
RendererNode
,
RendererElement
,
{
[
key
:
string
]:
any
}
>
,
{}
,
{}
,
{}
,
ComponentOptionsMixin
,
ComponentOptionsMixin
,
{
"build-complete"
:
(
_e
:
{
quality
:
QualityMode
;
segments
:
number
}
,
)
=>
true
;
"camera-change"
:
(
_state
:
CameraState
)
=>
true
;
disclosure
:
(
_text
:
string
)
=>
true
;
error
:
(
_e
:
{
code
:
string
;
message
:
string
}
)
=>
true
;
"machine-geometry-discovered"
:
(
_machine
:
MachineGeometry
)
=>
true
;
"machine-geometry-mismatch"
:
(
_message
:
string
)
=>
true
;
"parse-cancelled"
:
()
=>
true
;
"parse-error"
:
(
_e
:
{
code
:
string
;
message
:
string
}
)
=>
true
;
"parse-progress"
:
(
_p
:
{
bytesProcessed
:
number
;
totalBytes
:
number
}
,
)
=>
true
;
"progress-presentation-changed"
:
(
_e
:
{
mode
:
string
;
reason
?:
string
}
,
)
=>
true
;
"quality-fallback"
:
(
_e
:
{
from
:
QualityMode
;
reason
:
string
;
to
:
QualityMode
}
,
)
=>
true
;
ready
:
(
_summary
:
{
capabilities
:
Record
<
string
,
Confidence
>
;
complete
:
boolean
;
layers
:
number
;
metadata
:
undefined
|
DialectMetadata
;
segments
:
number
;
warnings
:
readonly
Warning
[]
;
}
,
)
=>
true
;
stage
:
(
_e
:
{
detail
?:
{
built
:
number
;
total
:
number
}
;
progress
?:
number
;
stage
:
PreparationStage
;
}
,
)
=>
true
;
}
,
string
,
PublicProps
,
ToResolvedProps
<
ExtractPropTypes
<
{
adjacentLayers
:
{
default
:
undefined
;
type
:
PropType
<
number
>
}
;
buildVolume
:
{
default
:
undefined
;
type
:
PropType
<
BuildVolumeDef
|
MachineGeometry
>
;
}
;
cameraMode
:
{
default
:
string
;
type
:
PropType
<
CameraMode
>
}
;
cameraState
:
{
default
:
undefined
;
type
:
PropType
<
null
|
CameraState
>
}
;
colorMode
:
{
default
:
undefined
;
type
:
PropType
<
ColorMode
>
}
;
createWorker
:
{
default
:
undefined
;
type
:
PropType
<
()
=>
WorkerLike
>
}
;
frameContent
:
{
default
:
string
;
type
:
PropType
<
"object"
|
"all"
>
}
;
hiddenFeatureRoles
:
{
default
:
undefined
;
type
:
PropType
<
FeatureRoleValue
[]
>
;
}
;
interactionQuality
:
{
default
:
string
;
type
:
PropType
<
"auto"
|
"off"
>
}
;
layerRange
:
{
default
:
null
;
type
:
PropType
<
null
|
[
number
,
number
]
>
}
;
parseOptions
:
{
default
:
undefined
;
type
:
PropType
<
WireParseOptions
>
}
;
progress
:
{
default
:
null
;
type
:
PropType
<
null
|
ProgressObservation
>
}
;
progressivePreview
:
{
default
:
undefined
;
type
:
PropType
<
ProgressivePreview
>
;
}
;
quality
:
{
default
:
string
;
type
:
PropType
<
QualityMode
|
"auto"
>
}
;
qualityMode
:
{
default
:
undefined
;
type
:
PropType
<
QualityPolicy
>
}
;
renderer
:
{
default
:
undefined
;
type
:
PropType
<
RendererMode
>
}
;
rendererOptions
:
{
default
:
undefined
;
type
:
PropType
<
Omit
<
{
adjacentLayers
?:
number
;
buildVolume
?:
BuildVolumeDef
;
cameraMode
?:
CameraMode
;
chunksPerTick
?:
number
;
colorMode
?:
ColorMode
;
createRenderer
?:
(
canvas
:
RenderTargetCanvas
)
=>
GLRendererLike
;
frameContent
?:
"object"
|
"all"
;
geometryConcurrency
?:
number
|
"auto"
|
"off"
;
geometryMemoryBudgetBytes
?:
number
;
ghostOpacity
?:
number
;
interactionQuality
?:
"auto"
|
"off"
;
mode
?:
RendererMode
;
progressivePreview
?:
ProgressivePreview
;
quality
?:
QualityMode
|
"auto"
;
qualityMode
?:
QualityPolicy
;
scheduleFrame
?:
(
cb
:
()
=>
...
)
=>
void
;
theme
?:
Theme
;
tube
?:
TubeOptions
;
}
,
|
"buildVolume"
|
"quality"
|
"qualityMode"
|
"progressivePreview"
|
"cameraMode"
|
"frameContent"
|
"interactionQuality"
|
"theme"
|
"colorMode"
|
"tube"
,
>
,
>
;
}
;
scrub
:
{
default
:
null
;
type
:
PropType
<
null
|
number
>
}
;
scrubTime
:
{
default
:
null
;
type
:
PropType
<
null
|
number
>
}
;
showRetractions
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
showTravel
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
showVolumeCage
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
showWipe
:
{
default
:
boolean
;
type
:
BooleanConstructor
}
;
source
:
{
default
:
null
;
type
:
PropType
<
GcodePreviewSource
>
}
;
theme
:
{
default
:
undefined
;
type
:
PropType
<
Theme
>
}
;
tube
:
{
default
:
undefined
;
type
:
PropType
<
TubeOptions
>
}
;
view
:
{
default
:
undefined
;
type
:
PropType
<
CameraView
>
}
;
}
,
>
,
{
"build-complete"
:
(
_e
:
{
quality
:
QualityMode
;
segments
:
number
}
,
)
=>
true
;
"camera-change"
:
(
_state
:
CameraState
)
=>
true
;
disclosure
:
(
_text
:
string
)
=>
true
;
error
:
(
_e
:
{
code
:
string
;
message
:
string
}
)
=>
true
;
"machine-geometry-discovered"
:
(
_machine
:
MachineGeometry
)
=>
true
;
"machine-geometry-mismatch"
:
(
_message
:
string
)
=>
true
;
"parse-cancelled"
:
()
=>
true
;
"parse-error"
:
(
_e
:
{
code
:
string
;
message
:
string
}
)
=>
true
;
"parse-progress"
:
(
_p
:
{
bytesProcessed
:
number
;
totalBytes
:
number
}
,
)
=>
true
;
"progress-presentation-changed"
:
(
_e
:
{
mode
:
string
;
reason
?:
string
}
,
)
=>
true
;
"quality-fallback"
:
(
_e
:
{
from
:
QualityMode
;
reason
:
string
;
to
:
QualityMode
}
,
)
=>
true
;
ready
:
(
_summary
:
{
capabilities
:
Record
<
string
,
Confidence
>
;
complete
:
boolean
;
layers
:
number
;
metadata
:
undefined
|
DialectMetadata
;
segments
:
number
;
warnings
:
readonly
Warning
[]
;
}
,
)
=>
true
;
stage
:
(
_e
:
{
detail
?:
{
built
:
number
;
total
:
number
}
;
progress
?:
number
;
stage
:
PreparationStage
;
}
,
)
=>
true
;
}
,
>
,
{
adjacentLayers
:
number
;
buildVolume
:
BuildVolumeDef
|
MachineGeometry
;
cameraMode
:
CameraMode
;
cameraState
:
null
|
CameraState
;
colorMode
:
ColorMode
;
createWorker
:
()
=>
WorkerLike
;
frameContent
:
"object"
|
"all"
;
hiddenFeatureRoles
:
FeatureRoleValue
[]
;
interactionQuality
:
"auto"
|
"off"
;
layerRange
:
null
|
[
number
,
number
]
;
parseOptions
:
WireParseOptions
;
progress
:
null
|
ProgressObservation
;
progressivePreview
:
ProgressivePreview
;
quality
:
QualityMode
|
"auto"
;
qualityMode
:
QualityPolicy
;
renderer
:
RendererMode
;
rendererOptions
:
Omit
<
{
adjacentLayers
?:
number
;
buildVolume
?:
BuildVolumeDef
;
cameraMode
?:
CameraMode
;
chunksPerTick
?:
number
;
colorMode
?:
ColorMode
;
createRenderer
?:
(
canvas
:
RenderTargetCanvas
)
=>
GLRendererLike
;
frameContent
?:
"object"
|
"all"
;
geometryConcurrency
?:
number
|
"auto"
|
"off"
;
geometryMemoryBudgetBytes
?:
number
;
ghostOpacity
?:
number
;
interactionQuality
?:
"auto"
|
"off"
;
mode
?:
RendererMode
;
progressivePreview
?:
ProgressivePreview
;
quality
?:
QualityMode
|
"auto"
;
qualityMode
?:
QualityPolicy
;
scheduleFrame
?:
(
cb
:
()
=>
void
)
=>
void
;
theme
?:
Theme
;
tube
?:
TubeOptions
;
}
,
|
"buildVolume"
|
"quality"
|
"qualityMode"
|
"progressivePreview"
|
"cameraMode"
|
"frameContent"
|
"interactionQuality"
|
"theme"
|
"colorMode"
|
"tube"
,
>
;
scrub
:
null
|
number
;
scrubTime
:
null
|
number
;
showRetractions
:
boolean
;
showTravel
:
boolean
;
showVolumeCage
:
boolean
;
showWipe
:
boolean
;
source
:
GcodePreviewSource
;
theme
:
Theme
;
tube
:
TubeOptions
;
view
:
CameraView
;
}
,
{}
,
{}
,
{}
,
string
,
ComponentProvideOptions
,
true
,
{}
,
any
,
>
= ...
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Guide
npm
GitHub
G-code Preview — API Reference
Loading...