IFClite TypeScript API
    Preparing search index...

    Class ListNamespace

    bim.list — Entity lists, property tables, column discovery, and CSV export

    Index
    • Discover available columns from a data provider. Returns all property sets and their properties found in the model.

      Parameters

      • provider: unknown
      • OptionalentityTypes: string[]

      Returns Promise<unknown>

    • Execute a list query against a data provider.

      const result = await bim.list.execute(myProvider, {
      types: ['IfcWall'],
      columns: [
      { header: 'Name', source: 'name' },
      { header: 'Type', source: 'type' },
      { header: 'External', source: 'Pset_WallCommon.IsExternal' },
      ],
      });

      Parameters

      Returns Promise<unknown>

    • Get the built-in entity attribute columns (name, type, globalId, etc.).

      Returns Promise<unknown[]>

    • Get available list presets (e.g. wall schedule, door schedule).

      Returns Promise<unknown[]>

    • Convert a list result to CSV string.

      Parameters

      • result: unknown

      Returns Promise<string>