Class DxfViewer

{en} Activates a layout.

{zh} 激活布局。

viewer.activateLayout('Layout1');

{en} Activates markup feature.

{zh} 激活标注功能。

const markupType = MarkupType.Arrow;
viewer.activateMarkup(markupType);

{en} Activates one of "Distance", "Area" or "Angle" measurement

{zh} 激活"距离", "面积" 或者 "角度"测量

viewer.activateMeasurement(MeasurementType.Distance);

use MeasurePlugin instead

Add model data to viewer.

{en} Cancels current measurement. This won't deactivate measurement, rather, you can start a new measurement.

{zh} 取消当前的测量绘制。这并不会退出测量，用户可以开始一个新的测量。

use MeasurePlugin instead

{en} Clears markups.

{zh} 清除所有标注。

viewer.clearMarkups();

{en} Clears measurement results.

{zh} 清除测量结果。

viewer.clearMeasurements();

use MeasurePlugin instead

{en} Deactivates markup feature.

{zh} 退出标注功能。

viewer.deactivateMarkup();

{en} Gets active layout.

{zh} 获取当前布局。

const activeLayout = viewer.getActiveLayoutName();
console.log(activeLayout);

{en} Gets active markup type.

{zh} 获取激活的标注类型。

const markupType = viewer.getActiveMarkupType();
console.log(markupType);

{en} Gets active measurement type.

{zh} 获取当前激活的测量类型。

const measurementType = viewer.getActiveMeasurementType();
console.log(measurementType);

use MeasurePlugin instead

{en} Gets current view extent. This is useful for user to save this value as a viewpoint, and jump to this viewpoint next time.

{zh} 获取当前视图范围。 用户可使用该接口获取当前视口范围，并在适当的场景下跳转到该视口范围。

const box = viewer.getCurrentViewExtent();
console.log("Current view extent:", box);

{en} Gets dxf layers.

{zh} 获取dxf图层。

const dxfLayers = viewer.getLayers();
for (let i = 0; i < dxfLayers.length; ++i) {
    const layers = dxfLayers[i].layers;
    const layerNames = Object.keys(layers).sort();
    console.log(layerNames);
}

{en} Gets layout names of the master model.

{zh} 获取主模型的布局名称。

const layoutNames = dxfViewer.getLayoutNames();
console.log(layoutNames); // ['Model', 'Layout1', 'Layout2']

{en} Gets all markups.

{zh} 获取所有标注数据。

const markupData = viewer.getMarkups();
console.log(markupData);

{en} Gets all measurements.

{zh} 获取所有测量数据。

const measurementData = viewer.getMeasurements();
console.log(measurementData);

use MeasurePlugin instead

{en} Gets screenshot of a rectangular area, or by box selecting an area. Returns an image in format of base64 string.

{zh} 获取矩形区域或者框选区域的截图。返回base64格式的图片。

// {en} Click on markup to take screenshot.
// {zh} 点击批注截屏。
const mode = ScreenshotMode.PickMarkup;
viewer.getScreenshot(mode).then(data => console.log(data));
// {en} Take screenshot by box selecting an area.
// {zh} 根据用户的框选截屏。
const mode = ScreenshotMode.BoxSelection;
viewer.getScreenshot(mode).then(data => console.log(data));
// {en} Take screenshot of the whole view.
// {zh} 全屏截屏。
const mode = ScreenshotMode.Default;
viewer.getScreenshot(mode).then(data => console.log(data));

use ScreenshotPlugin instead.

{en} Moves camera to home view.

{zh} 移动相机到主视图.

viewer.goToHomeView();

{en} Loads a dxf file. The first loaded file will be taken as a "master" model. Any other files are non-master, we call "overlay" model. We'll load everything of a master model, including model and paper space. For an overlay model, we'll only load its model space. And its model space can only overly to master model's model space.

{zh} 加载 dxf 文件。 第一个加载的文件将被视为“主”模型。 任何其他文件都是非主文件，我们称之为“叠加”模型。 我们将加载主模型的所有内容，包括模型和图纸空间。 对于叠加模型，我们只会加载其模型空间。并且它的模型空间只能叠加到主模型的模型空间上。

const viewerCfg = {
    containerId: "myCanvas",
};
const modelCfg = {
    modelId: "id_0",
    name: "dxf 0",
    src: "http://www.abc.com/sample.dxf",
}
const viewer = new DxfViewer(viewerCfg);
await viewer.loadModelAsync(modelCfg, (event) => {
    const progress = (event.loaded * 100) / event.total;
    console.log(`Loading progress: ${progress}%`);
});
console.log("Loaded");

{en} Removes a markup by markup id.

{zh} 根据标注id删除标注。

const markupId = "c6ea70a3-ddb0-4dd0-87c8-bd2491936428";
viewer.removeMarkup(markupId);

{en} Removes a measurement by id.

{zh} 根据id删除测量数据。

const id = "c6ea70a3-ddb0-4dd0-87c8-bd2491936428";
viewer.removeMeasurement(id);

use MeasurePlugin instead

{en} Sets background color.

{zh} 设置背景颜色。

// {en} Sets background to gray
// {zh} 设置背景为灰色
viewer.setBackgroundColor(0.5, 0.5, 0.5);

{en} Sets font. This needs to be called before loading a dxf, it won't affect any loaded text. It accepts shx or typeface formats. For typeface, it only support passing in 1 font file in the array for now.

{zh} 设置字体。 需要在加载dxf之前调用，不会影响已加载的文字。 支持shx或typeface格式。对于typeface，目前只支持传入1个字体文件。

viewer.setFont(["https://example.com/xxx.shx"]);

{en} Sets layer's visibility.

{zh} 设置图层的可见性。

Error

• {en}: Throws exception if given modelId doesn't exist.
• {zh} 如果给定的modelId不存在，则抛出异常。

// Hides layer "0"
viewer.setLayerVisibility("0", false);

{en} Adds markups to active layout.

{zh} 添加标注到当前布局。

const markupData = [{
    type: "ArrowMarkup",
    id: "c6ea70a3-ddb0-4dd0-87c8-bd2491936428",
    lineWidth: 2,
    strokeStyle: "#ff0000",
    fillStyle: "#ff000030",
    points: [[0, 0], [1000, 1000]],
}];
viewer.setMarkups(markupData);

{en} Sets measurement data.

{zh} 设置测量数据。

const measurementData = [{
    type: "Distance",
    id: "c6ea70a3-ddb0-4dd0-87c8-bd2491936428",
    points: [[0, 1000], [5000, 1000]],
}];
viewer.setMeasurements(measurementData);

use MeasurePlugin instead

{en} Updates a markup.

{zh} 更新标注。

const markupData = {
   type: "ArrowMarkup",
   id: "c6ea70a3-ddb0-4dd0-87c8-bd2491936428",
   lineWidth: 3,
   strokeStyle: "#ff0000",
   fillStyle: "#ff000030",
   points: [[0, 0], [1000, 1000]],
};
viewer.updateMarkup(markupData);

{en} Zooms to specific bounding box.

{zh} 缩放到指定的包围盒.

const box = { min: { x: 0, y: 0 }, max: { x: 10000, y: 10000} };
viewer.zoomToBBox(box);

{en} Zooms to view extent.

{zh} 缩放到视图范围.

viewer.zoomToExtent();

{en} Asks user to select a box area, and zooms to it.

{zh} 询问用户选择一个框选区域，然后缩放到该区域。

viewer.zoomToRect();