Class Model

Provides properties and methods for working with view of the file or assembly. For example, for dwg it is a Model space or layout, and for rvt files it is a 3D view.

Hierarchy (View Summary)

Constructors

constructor

Properties

headers path

Accessors

assembly data database default file fileId geometry id name type

Methods

deleteViewpoint downloadFileRange downloadResource downloadResourceRange getModels getModelTransformMatrix getReferences getSnapshot getSnapshotData getViewpoints partialDownloadResource saveViewpoint setModelTransformMatrix

Constructors

constructor

  • new Model(data: any, file: File | Assembly): Model

  • Parameters

    • data: any

      Raw model data received from the server.

    • file: File | Assembly

      The file/assembly instance that owns the model.

    Returns Model

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

assembly

  • get assembly(): Assembly

  • The Assembly instance that owns the model.

    Returns Assembly

data

  • get data(): any

  • Raw model data received from the server.

    Returns any

database

  • get database(): string

  • Scene description resource file name. Use downloadResource() to download scene description file.

    Returns string

default

  • get default(): boolean

  • true if this is default model.

    Returns boolean

file

  • get file(): File

  • The File instance that owns the model.

    Returns File

fileId

  • get fileId(): string

  • The ID of the file that owns the model.

    Returns string

geometry

  • get geometry(): string[]

  • The list of geometry data resource files. Use downloadResource() to download geometry data files.

    Returns string[]

id

  • get id(): string

  • Unique model ID.

    Returns string

name

  • get name(): string

  • Model name.

    Returns string

type

  • get type(): string

  • Model owner type, matches the file extension this is model of the file, or assembly for assemblies.

    Returns string

Methods

deleteViewpoint

  • deleteViewpoint(guid: string): Promise<any>

  • Deletes the specified viewpoint from the owner file/assembly.

    Parameters

    • guid: string

      Viewpoint GUID.

    Returns Promise<any>

    Returns the raw data of a deleted viewpoint.

downloadFileRange

  • downloadFileRange(
        requestId: number,
        records: any,
        dataId: string,
        onProgress?: (
            progress: number,
            chunk: Uint8Array,
            requestId: number,
        ) => void,
        signal?: AbortSignal,
    ): Promise<void>

  • Deprecated since 25.3. Use downloadResourceRange() instead.

    Parameters

    • requestId: number
    • records: any
    • dataId: string
    • OptionalonProgress: (progress: number, chunk: Uint8Array, requestId: number) => void
    • Optionalsignal: AbortSignal

    Returns Promise<void>

    Deprecated

downloadResource

  • downloadResource(
        dataId: string,
        onProgress?: (progress: number, chunk: Uint8Array) => void,
        signal?: AbortSignal,
    ): Promise<ArrayBuffer>

  • Downloads a resource file. Resource files are files that contain model scene descriptions, or geometry data.

    Parameters

    • dataId: string

      Resource file name.

    • OptionalonProgress: (progress: number, chunk: Uint8Array) => void

      Download progress callback.

    • Optionalsignal: AbortSignal

      An AbortController signal. Allows to communicate with a fetch request and abort it if desired.

    Returns Promise<ArrayBuffer>

downloadResourceRange

  • downloadResourceRange(
        dataId: string,
        requestId: number,
        ranges: { begin: number; end: number; requestId: number }[],
        onProgress?: (
            progress: number,
            chunk: Uint8Array,
            requestId: number,
        ) => void,
        signal?: AbortSignal,
    ): Promise<ArrayBuffer>

  • Downloads a part of resource file. Resource files are files that contain model scene descriptions, or geometry data.

    Parameters

    • dataId: string

      Resource file name.

    • requestId: number

      Specify a non-empty requestId to append the ?requestId= search parameter to the server request. If specified, server-side caching may not work.

    • ranges: { begin: number; end: number; requestId: number }[]

      A ranges of resource file contents to download. See HTTP range requests for more details.

    • OptionalonProgress: (progress: number, chunk: Uint8Array, requestId: number) => void

      Download progress callback.

    • Optionalsignal: AbortSignal

      An AbortController signal. Allows to communicate with a fetch request and abort it if desired.

    Returns Promise<ArrayBuffer>

getModels

  • getModels(): Promise<Model[]>

  • Returns model list with one item self.

    Returns Promise<Model[]>

getModelTransformMatrix

getReferences

  • getReferences(signal?: AbortSignal): Promise<IFileReferences>

  • Returns a list of references of the owner file/assembly.

    References are images, fonts, or any other files to correct rendering of the file.

    Parameters

    • Optionalsignal: AbortSignal

      An AbortController signal, which can be used to abort waiting as desired.

    Returns Promise<IFileReferences>

getSnapshot

  • getSnapshot(guid: string): Promise<string>

  • Returns viewpoint snapshot as base64-encoded Data URL.

    Parameters

    • guid: string

      Viewpoint GUID.

    Returns Promise<string>

getSnapshotData

  • getSnapshotData(guid: string, bitmapGuid: string): Promise<string>

  • Returns viewpoint snapshot data.

    Parameters

    • guid: string

      Viewpoint GUID.

    • bitmapGuid: string

      Bitmap GUID.

    Returns Promise<string>

getViewpoints

  • getViewpoints(): Promise<any[]>

  • Returns a list of viewpoints of the owner file/assembly.

    Returns Promise<any[]>

partialDownloadResource

  • partialDownloadResource(
        dataId: string,
        onProgress?: (progress: number, chunk: Uint8Array) => void,
        signal?: AbortSignal,
    ): Promise<ArrayBuffer>

  • Deprecated since 25.3. Use downloadResource() instead.

    Parameters

    • dataId: string
    • OptionalonProgress: (progress: number, chunk: Uint8Array) => void
    • Optionalsignal: AbortSignal

    Returns Promise<ArrayBuffer>

    Deprecated

saveViewpoint

  • saveViewpoint(viewpoint: any): Promise<any>

  • Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint use Viewer.createViewpoint().

    Parameters

    • viewpoint: any

      Viewpoint object.

    Returns Promise<any>

setModelTransformMatrix

  • setModelTransformMatrix(
        handle: string,
        transform?: IModelTransformMatrix,
    ): Promise<Model>

  • Sets or removes a model transformation.

    Parameters

    • handle: string

      Model handle.

    • Optionaltransform: IModelTransformMatrix

      Transformation matrix. Specify undefined to remove transformation.

    Returns Promise<Model>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods