IFClite TypeScript API
    Preparing search index...

    Class DrawingNamespace

    bim.drawing — 2D architectural drawing generation, styling, and export

    Index
    • Combine criteria with AND logic.

      Parameters

      • ...criteria: unknown[]

      Returns Promise<unknown>

    • Create a drawing frame.

      Parameters

      • options: unknown

      Returns Promise<unknown>

    • Create a graphic override engine from rules.

      Parameters

      • Optionalrules: unknown[]

      Returns Promise<unknown>

    • Create a title block.

      Parameters

      • options: unknown

      Returns Promise<unknown>

    • Export drawing data to SVG string.

      Parameters

      Returns Promise<string>

    • Generate a door symbol.

      Parameters

      • params: unknown

      Returns Promise<unknown>

    • Generate a stair arrow.

      Parameters

      • params: unknown

      Returns Promise<unknown>

    • Generate a window symbol.

      Parameters

      • params: unknown

      Returns Promise<unknown>

    • Get all common scales.

      Returns Promise<unknown[]>

    • Get dash patterns.

      Returns Promise<unknown>

    • Get the default AIA layer definitions.

      Returns Promise<unknown>

    • Get available frame presets.

      Returns Promise<unknown>

    • Get a hatch pattern by IFC type or material name.

      Parameters

      • key: string

      Returns Promise<unknown>

    • Get all hatch patterns.

      Returns Promise<unknown>

    • Get the AIA layer for an IFC type.

      Parameters

      • ifcType: string

      Returns Promise<unknown>

    • Get a specific line style.

      Parameters

      • key: string

      Returns Promise<unknown>

    • Get all line styles.

      Returns Promise<unknown>

    • Get available paper sizes.

      Returns Promise<unknown[]>

    • Get paper sizes from the registry, optionally by category.

      Parameters

      • Optionalcategory: string

      Returns Promise<unknown[]>

    • Get a specific built-in preset by name.

      Parameters

      • name: string

      Returns Promise<unknown>

    • Get all built-in graphic override presets.

      Returns Promise<unknown[]>

    • Get presets filtered by category.

      Parameters

      • category: string

      Returns Promise<unknown[]>

    • Get the tightest scale at which a drawing fits the sheet.

      Sizes are metres; paper is millimetres and defaults to A3 landscape. height defaults to width, which squares the extent and costs one to two steps of coarseness on an elongated plan (a 30 x 5 m plan squares to 1:200 where it fits at 1:100), so pass the real height when you have it.

      paperWidth and paperHeight are independent, so passing one and not the other composes a sheet that is no real paper size: (30, 20, 594) is 594 wide by A3's 297 tall. Pass both or neither. They are not paired into one argument because that would change the shape of a published signature for a hazard a sentence can cover.

      Throws on a non-finite or non-positive size. It previously returned a scale for those, so a caller relying on that gets an exception now.

      Parameters

      • width: number
      • Optionalheight: number
      • OptionalpaperWidth: number
      • OptionalpaperHeight: number

      Returns Promise<unknown>

    • Get available title block presets.

      Returns Promise<unknown>

    • Get line weight configuration by IFC type.

      Returns Promise<unknown>

    • Create a criterion that matches by IFC type(s).

      Parameters

      • types: string | string[]
      • OptionalincludeSubtypes: boolean

      Returns Promise<unknown>

    • Check if GPU compute is available for accelerated section cutting.

      Returns Promise<boolean>

    • Get the math utilities module (vec3, point2d, bounds, etc.).

      Returns Promise<
          {
              boundsCenter: AnyFn;
              boundsEmpty: AnyFn;
              boundsExtendPoint: AnyFn;
              boundsSize: AnyFn;
              EPSILON: number;
              lineDirection: AnyFn;
              lineLength: AnyFn;
              lineMidpoint: AnyFn;
              point2D: AnyFn;
              point2DAdd: AnyFn;
              point2DDistance: AnyFn;
              point2DSub: AnyFn;
              vec3: AnyFn;
              vec3Add: AnyFn;
              vec3Cross: AnyFn;
              vec3Distance: AnyFn;
              vec3Dot: AnyFn;
              vec3Length: AnyFn;
              vec3Normalize: AnyFn;
              vec3Scale: AnyFn;
              vec3Sub: AnyFn;
              [key: string]: unknown;
          },
      >

    • Combine criteria with OR logic.

      Parameters

      • ...criteria: unknown[]

      Returns Promise<unknown>

    • Create a criterion that matches by property value.

      Parameters

      • propertyName: string
      • operator: string
      • Optionalvalue: unknown
      • OptionalpropertySet: string

      Returns Promise<unknown>