@inweb/viewer-visualize/src/Viewer/Commands/GetSnapshot.ts

JavaScript library for rendering CAD and BIM files in a browser using VisualizeJS

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2026, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2026 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

import { Viewer } from "../Viewer";

export function getSnapshot(viewer: Viewer, type?: string, quality?: number): string {
  if (!viewer.visualizeJs) return "";

  const mimeType = type ?? viewer.options.snapshotMimeType ?? "image/jpeg";
  const imageQuality = quality ?? viewer.options.snapshotQuality ?? 0.25;

  if (viewer.markup) {
    return viewer.markup.getSnapshot(mimeType, imageQuality);
  }

  return viewer.canvas?.toDataURL(mimeType, imageQuality) || "";
}