Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Private

Index

Variables

Const BackgroundPresets

BackgroundPresets: Map<string, number[]>[]

Const LightPresets

LightPresets: LightPreset[]

Functions

getParameterByName

  • getParameterByName(name: string): string
  • Returns the query parameter value from window url.

    Parameters

    • name: string

      Parameter name in the URL querying string.

    Returns string

getParameterByNameFromPath

  • getParameterByNameFromPath(name: string, url: string): string
  • return value of parameter from a url.

    Parameters

    • name: string
    • url: string

    Returns string

getResourceUrl

  • getResourceUrl(resourceRelativePath: string): string
  • Returns the full url of a resource with version. The version will be determined from the LMV_VIEWER_VERSION variable.

    Parameters

    • resourceRelativePath: string

      The path of the resource relative to LMV_RESOURCE_ROOT.

    Returns string

    The full resource path.

getScript

  • getScript(scriptName: string): HTMLScriptElement
  • Returns the first source url found containing the given script name.

    Parameters

    • scriptName: string

      Script name.

    Returns HTMLScriptElement

    The script element whose source location matches the input parameter.

initializeAuth

  • initializeAuth(onSuccessCallback: function, options: Object): void
  • Parameters

    • onSuccessCallback: function
        • (response: any): void
        • Parameters

          • response: any

          Returns void

    • options: Object

    Returns void

initializeEnvironmentVariable

  • initializeEnvironmentVariable(options: Object): void
  • Parameters

    • options: Object

    Returns void

initializeLocalization

  • initializeLocalization(options: Object): void
  • Parameters

    • options: Object

    Returns void

initializeLogger

  • initializeLogger(options: Object): void
  • Parameters

    • options: Object

    Returns void

initializeServiceEndPoints

  • initializeServiceEndPoints(options: Object): void
  • Parameters

    • options: Object

    Returns void

initializeUserInfo

  • initializeUserInfo(options: Object): void
  • Parameters

    • options: Object

    Returns void

loadDependency

  • loadDependency(libNamespace: string, libName: string, callback: function): void
  • Loads a script (e.g. an external library JS) and calls the callback once loaded. Used for delayed loading of required libraries. Accepts both relative and absolute URLs.

    Parameters

    • libNamespace: string

      Library namespace in global scope.

    • libName: string

      Library filenmae.

    • callback: function

      Function called while library was loaded.

        • (): void
        • Returns void

    Returns void

refreshCookie

  • refreshCookie(token: string, onSuccess: function, onError: function): void
  • Parameters

    • token: string
    • onSuccess: function
        • (response: any): void
        • Parameters

          • response: any

          Returns void

    • onError: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

refreshRequestHeader

  • refreshRequestHeader(token: string): void
  • Refresh the token in request header, in case that the third party cookie is disabled.

    Parameters

    • token: string

      Forge access token.

    Returns void

refreshToken

  • refreshToken(token: string, onSuccess: function, onError: function): void
  • Parameters

    • token: string
    • onSuccess: function
        • (response: any): void
        • Parameters

          • response: any

          Returns void

    • onError: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

setLanguage

  • setLanguage(language: string, callback: function): void
  • Parameters

    • language: string
    • callback: function
        • (): void
        • Returns void

    Returns void

Autodesk 2018 © All Rights Reserved