Documentation - v19.2.0-dev
Preparing search index...
@stereograph/teiaviewer-plugins
TwinObjectApi
Function TwinObjectApi
TwinObjectApi
(
client
:
ApiClient
,
)
:
{
flattenedObjectProperties_deprecated
(
twin
:
Twin
)
:
Promise
<
string
[]
>
;
getGeometryInfo
(
endpoint
:
string
,
hash
:
string
,
geometryType
:
TwinObjectGeometryType
,
)
:
Promise
<
number
>
;
getGeometryRequest
(
endpoint
:
string
,
hash
:
string
,
pageNumber
:
number
,
pageSize
:
number
,
geometryType
:
TwinObjectGeometryType
,
)
:
FileRequest
;
getTwinObject
<
TFamily
extends
"Primitive"
|
"TwinBimData"
|
"TwinOpenData"
|
"TwinUserData"
,
>
(
twin
:
Twin
,
uuid
:
string
,
families
?:
TFamily
[]
,
)
:
Promise
<
TwinObject
<
TwinObjectPropertiesByFamily
<
TFamily
>
[]
>
>
;
getTwinTreeView
(
twinProjectId
:
number
)
:
Promise
<
TreeViewChild
>
;
search
(
hash
:
string
,
pageNumber
:
number
,
pageSize
:
number
,
)
:
Promise
<
ApiDataList
<
TwinObject
<
TwinObjectProperty
[]
>
>
>
;
}
Parameters
client
:
ApiClient
Returns
{
flattenedObjectProperties_deprecated
(
twin
:
Twin
)
:
Promise
<
string
[]
>
;
getGeometryInfo
(
endpoint
:
string
,
hash
:
string
,
geometryType
:
TwinObjectGeometryType
,
)
:
Promise
<
number
>
;
getGeometryRequest
(
endpoint
:
string
,
hash
:
string
,
pageNumber
:
number
,
pageSize
:
number
,
geometryType
:
TwinObjectGeometryType
,
)
:
FileRequest
;
getTwinObject
<
TFamily
extends
"Primitive"
|
"TwinBimData"
|
"TwinOpenData"
|
"TwinUserData"
,
>
(
twin
:
Twin
,
uuid
:
string
,
families
?:
TFamily
[]
,
)
:
Promise
<
TwinObject
<
TwinObjectPropertiesByFamily
<
TFamily
>
[]
>
>
;
getTwinTreeView
(
twinProjectId
:
number
)
:
Promise
<
TreeViewChild
>
;
search
(
hash
:
string
,
pageNumber
:
number
,
pageSize
:
number
,
)
:
Promise
<
ApiDataList
<
TwinObject
<
TwinObjectProperty
[]
>
>
>
;
}
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Documentation - v19.2.0-dev
Loading...