Viewer
    Preparing search index...

    Type Alias SessionCreationDefinition

    type SessionCreationDefinition = {
        modelViewUrl: string;
        allowOutputLoading?: boolean;
        directTextureDownload?: boolean;
        excludeViewports?: string[];
        guid?: string;
        id?: string;
        ignoreUnknownParams?: boolean;
        initialParameterValues?: { [key: string]: string };
        jwtToken?: string;
        loadOutputs?: boolean;
        loadSdtf?: boolean;
        modelStateId?: string;
        modelStateValidationMode?: string;
        throwOnCustomizationError?: boolean;
        ticket?: string;
        waitForOutputs?: boolean;
    }
    Index

    Properties

    modelViewUrl allowOutputLoading? directTextureDownload? excludeViewports? guid? id? ignoreUnknownParams? initialParameterValues? jwtToken? loadOutputs? loadSdtf? modelStateId? modelStateValidationMode? throwOnCustomizationError? ticket? waitForOutputs?

    Properties

    modelViewUrl: string

    The modelViewUrl of the Geometry Backend hosting the model.

    allowOutputLoading?: boolean

    Option to allow the outputs to be loaded, or to prevent them from being loaded. (default: true)

    directTextureDownload?: boolean

    Fetch texture URLs directly in the browser. (default: false)

    ShapeDiver texture assets are fetched from their URL. Other texture URLs are downloaded through the Geometry Backend, which reads them for the viewer. Set this to true to request those URLs from the browser. The host must allow cross-origin reads from the viewer.

    excludeViewports?: string[]

    Option to exclude some viewports from the start. Can be accessed via ISessionApi.excludeViewports.

    guid?: string

    The geometry backend model id (guid). This identifies the model on the Geometry Backend. A jwtToken is needed for authentication. If no guid was provided, a ticket has to be provided instead.

    id?: string

    The unique identifier of the session that was specified or automatically chosen on creation of the session.

    ignoreUnknownParams?: boolean

    Option to allow relaxed validation of parameter identifiers. When set to true, unrecognized parameters will be ignored rather than causing an error. (default: false)

    initialParameterValues?: { [key: string]: string }

    The initial set of parameter values to use. Map from parameter id to parameter value. The default value will be used for any parameter not specified.

    jwtToken?: string

    The JWT used for authorizing API calls to the Geometry Backend.

    loadOutputs?: boolean

    Option to load the outputs, or not load them until the first call of ISessionApi.customize. (default: true)

    loadSdtf?: boolean

    Option to load the SDTF data. The data is not loaded by default as it can be quite large. (default: false)

    modelStateId?: string

    The optional model state id to use for the session. If not provided, no model state will be loaded.

    modelStateValidationMode?: string

    The optional model state validation mode to use for the session. If not provided, the default validation mode of the Geometry SDK will be used.

    throwOnCustomizationError?: boolean

    Option to throw an error if parts of a customization failed. (default: false)

    ticket?: string

    The ticket for direct embedding of the model represented by the session. This identifies the model on the Geometry Backend. If no ticket was provided, a guid has to be provided instead.

    waitForOutputs?: boolean

    Option to wait for the outputs to be loaded, or return immediately after creation of the session. (default: true)

    Settings

    Member Visibility

    On This Page

    Properties