Interface AcDbOpenDatabaseOptions

Options for reading a drawing database.

These options control how a drawing database is opened and processed.

interface AcDbOpenDatabaseOptions {
    circleSides?: number;
    drawNoPlotLayers?: boolean;
    encoding?: string;
    fileName?: string;
    minimumChunkSize?: number;
    readOnly?: boolean;
    sysVars?: Record<string, string | number | boolean>;
    timeout?: number;
}

Properties

circleSides? drawNoPlotLayers? encoding? fileName? minimumChunkSize? readOnly? sysVars? timeout?

Properties

OptionalcircleSides

circleSides?: number

Maximum number of segments used to tessellate a full circle when drawing.

Lower values use less GPU memory and produce smaller HTML exports; higher values look smoother on large arcs. Clamped to the DXF VPORT range [{@link AcGeCircArc2d.MIN_CIRCLE_SIDES}, {@link AcGeCircArc2d.MAX_CIRCLE_SIDES}]. When omitted, ACDB_DRAW_CIRCLE_SIDES_DRAFT (50) is used so AutoCAD's common VIEWRES 1000 is not applied accidentally.

Short arcs still use fewer segments than a full circle.

OptionaldrawNoPlotLayers

drawNoPlotLayers?: boolean

Whether entities on non-plottable ("no-plot") layers are drawn.

  • true (default): desktop AutoCAD editor semantics — no-plot layers remain visible on screen (Defpoints, viewport frames on *-NPLT, etc.).
  • false: web/publish viewer semantics (e.g. BIM 360 / ACC) — entities on no-plot layers are omitted from display.

Optionalencoding

encoding?: string

Override the text encoding used to decode text content (layer names, annotations, text entities, block attributes, ...).

When omitted, the encoding is auto-detected from the file (DXF reads $DWGCODEPAGE; DWG reads the header code page). When provided, it wins over auto-detection — for example 'cp949' or 'euc-kr' for Korean drawings whose declared code page is missing or wrong.

OptionalfileName

fileName?: string

File name of the drawing being opened, including extension (for example Plan.dwg).

When provided, updates the read-only DWGNAME system variable for this database.

OptionalminimumChunkSize

minimumChunkSize?: number

The minimum number of items in one chunk.

If this value is greater than the total number of entities in the drawing database, the total number is used. This controls how the database processing is broken into chunks for better performance.

OptionalreadOnly

readOnly?: boolean

Opens the drawing database in read-only mode.

When true, the database will be opened in read-only mode, preventing any modifications to the database content.

OptionalsysVars

sysVars?: Record<string, string | number | boolean>

System variables to override in the database.

This allows overriding system variable values when opening a database. For example, to disable line weight display regardless of the database's stored value, set { 'lwdisplay': false }.

The keys are system variable names (case-insensitive), and values can be number, boolean, or string types.

Optionaltimeout

timeout?: number

Timeout for web worker parsing in milliseconds.

This option is used only when the selected converter parses the drawing file in a web worker. If omitted, the converter-level timeout is used.

Settings

Member Visibility

On This Page

Properties