Documentation - v19.2.0-dev
Preparing search index...
@stereograph/teiaviewer-plugins
TwinProjectionApi
Function TwinProjectionApi
TwinProjectionApi
(
client
:
ApiClient
,
)
:
{
addProjection
(
twin
:
Twin
,
createProjectionBody
:
NewProjectionConfig
,
)
:
Promise
<
void
>
;
deleteProjection
(
projectId
:
number
,
projectionCfgId
:
number
)
:
Promise
<
void
>
;
downloadConfiguration
(
twin
:
Twin
,
projectionCfgId
:
number
)
:
Promise
<
string
>
;
downloadExport
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
format
:
string
,
)
:
Promise
<
string
>
;
downloadReport
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
)
:
Promise
<
string
>
;
generateReport
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
)
:
Promise
<
void
>
;
getAnalysis
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
pageNumber
:
number
,
pageSize
:
number
,
orderBy
?:
string
,
orderDirection
?:
string
,
)
:
Promise
<
ApiDataList
<
Analysis
>
>
;
getSVGPaths
(
twin
:
Twin
,
twinProjectionLayerId
:
number
,
pageSize
?:
number
,
pageNumber
?:
number
,
)
:
Promise
<
ApiDataList
<
SVGPath
>
>
;
getTwinProjections
(
twin
:
Twin
,
pageNumber
:
number
,
pageSize
:
number
,
name
?:
string
,
statusList
?:
(
|
"Completed"
|
"Failed"
|
"Degraded"
|
"InProgress"
|
"ToDo"
|
"Deleted"
)
[]
,
orderBy
?:
string
,
orderDirection
?:
string
,
)
:
Promise
<
ApiDataList
<
ProjectionConfig
>
>
;
importConfiguration
(
twin
:
Twin
,
files
:
File
[]
)
:
Promise
<
string
>
;
updateProjection
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
updateProjectionBody
:
UpdatedProjectionConfig
,
)
:
Promise
<
void
>
;
}
Parameters
client
:
ApiClient
Returns
{
addProjection
(
twin
:
Twin
,
createProjectionBody
:
NewProjectionConfig
,
)
:
Promise
<
void
>
;
deleteProjection
(
projectId
:
number
,
projectionCfgId
:
number
)
:
Promise
<
void
>
;
downloadConfiguration
(
twin
:
Twin
,
projectionCfgId
:
number
)
:
Promise
<
string
>
;
downloadExport
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
format
:
string
,
)
:
Promise
<
string
>
;
downloadReport
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
)
:
Promise
<
string
>
;
generateReport
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
)
:
Promise
<
void
>
;
getAnalysis
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
pageNumber
:
number
,
pageSize
:
number
,
orderBy
?:
string
,
orderDirection
?:
string
,
)
:
Promise
<
ApiDataList
<
Analysis
>
>
;
getSVGPaths
(
twin
:
Twin
,
twinProjectionLayerId
:
number
,
pageSize
?:
number
,
pageNumber
?:
number
,
)
:
Promise
<
ApiDataList
<
SVGPath
>
>
;
getTwinProjections
(
twin
:
Twin
,
pageNumber
:
number
,
pageSize
:
number
,
name
?:
string
,
statusList
?:
(
|
"Completed"
|
"Failed"
|
"Degraded"
|
"InProgress"
|
"ToDo"
|
"Deleted"
)
[]
,
orderBy
?:
string
,
orderDirection
?:
string
,
)
:
Promise
<
ApiDataList
<
ProjectionConfig
>
>
;
importConfiguration
(
twin
:
Twin
,
files
:
File
[]
)
:
Promise
<
string
>
;
updateProjection
(
twin
:
Twin
,
twinProjectionConfigurationId
:
number
,
updateProjectionBody
:
UpdatedProjectionConfig
,
)
:
Promise
<
void
>
;
}
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Documentation - v19.2.0-dev
Loading...