Request

Response

    Type Definitions
    Version 8 preview
    This page documents a preview of the Viewer SDK v8. APIs and content can still change before the final release.

    LoadOptions

    Options passed to Viewer3D#loadDocumentNode and Viewer3D#loadModel.

    Properties

    fileLoaderThe file loader to use for this url. Required for unsupported file types.
    keepCurrentModels
    boolean
    Flag indicating whether viewer should keep or unload all other models.
    loadOptions
    object
    May contain params that are specific for certain loaders/filetypes.
    sharedPropertyDbPath
    string
    Optional path to shared property database. Some documents have a global Property Database file, which is shared across all referenced 2D and 3D models. Use Document.getFullPath(Document.getRoot().findPropertyDbPath()) to populate this field, in case you are calling Viewer3D.loadModel directly and not using loadDocumentNode, which populates the property automatically.
    ids
    string
    A list of object IDs to load.
    loadAsHidden
    boolean
    By default, a new model is instantly shown and triggers viewer refreshes during loading. Setting this option avoids that. The model can then be shown later by calling showModel().
    modelNameOverride
    string
    Allows host application to override model name used in UI.
    placementTransformApplied to the model during loading.
    applyScaling
    string, Object
    Unit-Scaling that is applied to the model on load, e.g. { from: ‘ft’, to: ‘m’ }. If ‘from’ is not set, it is determined from model metadata (if provided). If only ‘to’ is set, you can just assign a string directly, e.g. applyScaling = ‘m’ is the same as applyScaling = { to: ‘m’ }.
    applyPlacementInModelUnits
    boolean
    Only relevant if options.placementTransform and options.applyScaling are both used at once. In this way, it controls the order in which placement and scaling happen:* False: Placement happens in viewer world-units. That is, applyScaling is done first, then the custom placementMatrix is applied. (Default behavior)* True: Placement happens in model units. That is, custom placementMatrix is applied first, then the unit scaling.
    useFileProfile
    boolean
    if set to true one of the registered file profiles will be used to set the profile. Otherwise, the viewer uses the default profile.
    filterLoad-time filter for selective loading. Only objects passing the queries are loaded.