Core¶

Core ifcopenshell API.

Classes¶

EntityInstance¶

Defined in: ifcopenshell-js/src/entity_instance.ts:27

IFC entity instance with attribute conveniences.

Extends¶

  • IfcOpenshellInstance

Constructors¶

Constructor¶

new EntityInstance(handle): EntityInstance

Defined in: ifcopenshell-js/src/entity_instance.ts:28

Parameters¶
handle¶

IfcOpenshellInstance

Returns¶

EntityInstance

Overrides¶

IfcOpenshellInstance.constructor

Properties¶

ptr¶

readonly ptr: number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:361

Inherited from¶

IfcOpenshellInstance.ptr

Methods¶

attributeCategory()¶

attributeCategory(name): number

Defined in: ifcopenshell-js/src/entity_instance.ts:127

Parameters¶
name¶

string

Returns¶

number

attributeIndex()¶

attributeIndex(name): number

Defined in: ifcopenshell-js/src/entity_instance.ts:114

Parameters¶
name¶

string

Returns¶

number

attributeName()¶

attributeName(index): string

Defined in: ifcopenshell-js/src/entity_instance.ts:118

Parameters¶
index¶

number

Returns¶

string

attributes()¶

attributes(): string[]

Defined in: ifcopenshell-js/src/entity_instance.ts:53

Returns¶

string[]

attributeType()¶

attributeType(nameOrIndex): string

Defined in: ifcopenshell-js/src/entity_instance.ts:122

Parameters¶
nameOrIndex¶

string | number

Returns¶

string

className()¶

className(with_schema): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:363

Parameters¶
with_schema¶

boolean

Returns¶

string

Inherited from¶

IfcOpenshellInstance.className

declaration()¶

declaration(): IfcOpenshellDeclaration

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:364

Returns¶

IfcOpenshellDeclaration

Inherited from¶

IfcOpenshellInstance.declaration

destroy()¶

destroy(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:362

Returns¶

void

Inherited from¶

IfcOpenshellInstance.destroy

entries()¶

entries(): [string, AttributeValueType][]

Defined in: ifcopenshell-js/src/entity_instance.ts:57

Returns¶

[string, AttributeValueType][]

file()¶

file(): IfcOpenshellFile | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:365

Returns¶

IfcOpenshellFile | null

Inherited from¶

IfcOpenshellInstance.file

filePointer()¶

filePointer(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:366

Returns¶

number

Inherited from¶

IfcOpenshellInstance.filePointer

get()¶

get(nameOrIndex): AttributeValueType

Defined in: ifcopenshell-js/src/entity_instance.ts:42

Parameters¶
nameOrIndex¶

string | number

Returns¶

AttributeValueType

getArgument()¶

getArgument(attribute_index): AttributeValueType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:367

Parameters¶
attribute_index¶

number

Returns¶

AttributeValueType

Inherited from¶

IfcOpenshellInstance.getArgument

getArgumentByName()¶

getArgumentByName(name): AttributeValueType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:368

Parameters¶
name¶

string

Returns¶

AttributeValueType

Inherited from¶

IfcOpenshellInstance.getArgumentByName

getArgumentIndex()¶

getArgumentIndex(name): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:369

Parameters¶
name¶

string

Returns¶

number

Inherited from¶

IfcOpenshellInstance.getArgumentIndex

getArgumentName()¶

getArgumentName(index): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:370

Parameters¶
index¶

number

Returns¶

string

Inherited from¶

IfcOpenshellInstance.getArgumentName

getArgumentType()¶

getArgumentType(index): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:371

Parameters¶
index¶

number

Returns¶

string

Inherited from¶

IfcOpenshellInstance.getArgumentType

getAttributeCategory()¶

getAttributeCategory(name): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:372

Parameters¶
name¶

string

Returns¶

number

Inherited from¶

IfcOpenshellInstance.getAttributeCategory

getAttributeNames()¶

getAttributeNames(): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:373

Returns¶

string[]

Inherited from¶

IfcOpenshellInstance.getAttributeNames

getAttributeValue()¶

getAttributeValue(index): AttributeValueType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:374

Parameters¶
index¶

number

Returns¶

AttributeValueType

Inherited from¶

IfcOpenshellInstance.getAttributeValue

getInfo()¶
Call Signature¶

getInfo(options?): EntityInstanceInfo

Defined in: ifcopenshell-js/src/entity_instance.ts:66

Return the entity id, type, and decoded forward attributes.

With recursive, referenced entities are expanded as well.

Parameters¶
options?¶

GetInfoOptions<EntityInstanceInfo<never>>

Returns¶

EntityInstanceInfo

Call Signature¶

getInfo<T>(options): T

Defined in: ifcopenshell-js/src/entity_instance.ts:67

Return the entity id, type, and decoded forward attributes.

With recursive, referenced entities are expanded as well.

Type Parameters¶
T¶

T

Parameters¶
options¶

Omit<GetInfoOptions<T>, "returnType"> & object

Returns¶

T

getInverse()¶

getInverse(name): IfcOpenshellInstance[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:375

Parameters¶
name¶

string

Returns¶

IfcOpenshellInstance[]

Inherited from¶

IfcOpenshellInstance.getInverse

getInverseAttributeByName()¶

getInverseAttributeByName(name): IfcOpenshellInstance[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:376

Parameters¶
name¶

string

Returns¶

IfcOpenshellInstance[]

Inherited from¶

IfcOpenshellInstance.getInverseAttributeByName

getInverseAttributeNames()¶

getInverseAttributeNames(): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:377

Returns¶

string[]

Inherited from¶

IfcOpenshellInstance.getInverseAttributeNames

id()¶

id(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:378

Returns¶

number

Inherited from¶

IfcOpenshellInstance.id

identity()¶

identity(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:379

Returns¶

number

Inherited from¶

IfcOpenshellInstance.identity

inverse()¶

inverse(name): EntityInstance[]

Defined in: ifcopenshell-js/src/entity_instance.ts:110

Return entities referenced by the named inverse attribute.

Parameters¶
name¶

string

Returns¶

EntityInstance[]

inverseAttributes()¶

inverseAttributes(): string[]

Defined in: ifcopenshell-js/src/entity_instance.ts:105

Returns¶

string[]

isA()¶
Call Signature¶

isA(name): boolean

Defined in: ifcopenshell-js/src/entity_instance.ts:34

Parameters¶
name¶

string

Returns¶

boolean

Overrides¶

IfcOpenshellInstance.isA

Call Signature¶

isA(withSchema?): string

Defined in: ifcopenshell-js/src/entity_instance.ts:35

Parameters¶
withSchema?¶

boolean

Returns¶

string

Overrides¶

IfcOpenshellInstance.isA

set()¶

set(nameOrIndex, value): void

Defined in: ifcopenshell-js/src/entity_instance.ts:131

Parameters¶
nameOrIndex¶

string | number

value¶

AttributeValueType

Returns¶

void

setArgument()¶

setArgument(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:400

Parameters¶
index¶

number

value¶

AttributeValueType

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgument

setArgumentAsAggregateOfAggregateOfEntityInstance()¶

setArgumentAsAggregateOfAggregateOfEntityInstance(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:381

Parameters¶
index¶

number

value¶

number[][]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentAsAggregateOfAggregateOfEntityInstance

setArgumentBool()¶

setArgumentBool(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:382

Parameters¶
index¶

number

value¶

boolean

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentBool

setArgumentDouble()¶

setArgumentDouble(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:383

Parameters¶
index¶

number

value¶

number

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentDouble

setArgumentDoubleList()¶

setArgumentDoubleList(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:384

Parameters¶
index¶

number

value¶

number[]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentDoubleList

setArgumentDoubleListList()¶

setArgumentDoubleListList(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:385

Parameters¶
index¶

number

value¶

number[][]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentDoubleListList

setArgumentEnumeration()¶

setArgumentEnumeration(index, enumeration, enumeration_index): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:386

Parameters¶
index¶

number

enumeration¶

IfcOpenshellEnumeration

enumeration_index¶

number

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentEnumeration

setArgumentEnumerationByName()¶

setArgumentEnumerationByName(index, value): boolean

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:387

Parameters¶
index¶

number

value¶

string

Returns¶

boolean

Inherited from¶

IfcOpenshellInstance.setArgumentEnumerationByName

setArgumentInstance()¶

setArgumentInstance(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:388

Parameters¶
index¶

number

value¶

IfcOpenshellInstance

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentInstance

setArgumentInstanceList()¶

setArgumentInstanceList(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:389

Parameters¶
index¶

number

value¶

IfcOpenshellInstance[]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentInstanceList

setArgumentInt32()¶

setArgumentInt32(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:390

Parameters¶
index¶

number

value¶

number

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentInt32

setArgumentInt32List()¶

setArgumentInt32List(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:391

Parameters¶
index¶

number

value¶

number[]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentInt32List

setArgumentInt32ListList()¶

setArgumentInt32ListList(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:392

Parameters¶
index¶

number

value¶

number[][]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentInt32ListList

setArgumentLogical()¶

setArgumentLogical(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:393

Parameters¶
index¶

number

value¶

number

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentLogical

setArgumentString()¶

setArgumentString(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:394

Parameters¶
index¶

number

value¶

string

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentString

setArgumentStringList()¶

setArgumentStringList(index, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:395

Parameters¶
index¶

number

value¶

string[]

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setArgumentStringList

setAttributeValue()¶

setAttributeValue(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:396

Parameters¶
name¶

string

value¶

AttributeValueType

Returns¶

void

Inherited from¶

IfcOpenshellInstance.setAttributeValue

toString()¶

toString(valid_spf): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:397

Parameters¶
valid_spf¶

boolean

Returns¶

string

Inherited from¶

IfcOpenshellInstance.toString

unsetArgument()¶

unsetArgument(index): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:398

Parameters¶
index¶

number

Returns¶

void

Inherited from¶

IfcOpenshellInstance.unsetArgument

unsetAttributeValue()¶

unsetAttributeValue(name): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:399

Parameters¶
name¶

string

Returns¶

void

Inherited from¶

IfcOpenshellInstance.unsetAttributeValue

File¶

Defined in: ifcopenshell-js/src/file.ts:20

High-level wrapper for an IFC file and its entity graph.

Extends¶

  • IfcOpenshellFile

Constructors¶

Constructor¶

new File(schemaOrHandle?): File

Defined in: ifcopenshell-js/src/file.ts:22

Create an empty file, or take ownership of an existing native file handle.

Parameters¶
schemaOrHandle?¶

string | IfcOpenshellFile

Returns¶

File

Overrides¶

IfcOpenshellFile.constructor

Properties¶

byGuid¶

byGuid: (guid) => EntityInstance

Defined in: ifcopenshell-js/src/file.ts:62

Parameters¶
guid¶

string

Returns¶

EntityInstance

Overrides¶

IfcOpenshellFile.byGuid

byId¶

byId: (id) => EntityInstance

Defined in: ifcopenshell-js/src/file.ts:61

Parameters¶
id¶

number

Returns¶

EntityInstance

Overrides¶

IfcOpenshellFile.byId

byType¶

byType: (typeName) => EntityInstance[]

Defined in: ifcopenshell-js/src/file.ts:63

Parameters¶
typeName¶

string

Returns¶

EntityInstance[]

Overrides¶

IfcOpenshellFile.byType

byTypeExclSubtypes¶

byTypeExclSubtypes: (typeName) => EntityInstance[]

Defined in: ifcopenshell-js/src/file.ts:64

Parameters¶
typeName¶

string

Returns¶

EntityInstance[]

Overrides¶

IfcOpenshellFile.byTypeExclSubtypes

ptr¶

readonly ptr: number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:212

Inherited from¶

IfcOpenshellFile.ptr

traverse¶

traverse: (entity, maxDepth) => EntityInstance[]

Defined in: ifcopenshell-js/src/file.ts:65

Parameters¶
entity¶

EntityInstance

maxDepth¶

number

Returns¶

EntityInstance[]

Overrides¶

IfcOpenshellFile.traverse

traverseBreadthFirst¶

traverseBreadthFirst: (entity, maxDepth) => EntityInstance[]

Defined in: ifcopenshell-js/src/file.ts:66

Parameters¶
entity¶

EntityInstance

maxDepth¶

number

Returns¶

EntityInstance[]

Overrides¶

IfcOpenshellFile.traverseBreadthFirst

Accessors¶

entityCount¶
Get Signature¶

get entityCount(): number

Defined in: ifcopenshell-js/src/file.ts:57

Returns¶

number

ids¶
Get Signature¶

get ids(): number[]

Defined in: ifcopenshell-js/src/file.ts:52

Returns¶

number[]

maxId¶
Get Signature¶

get maxId(): number

Defined in: ifcopenshell-js/src/file.ts:48

Returns¶

number

Methods¶

[asyncDispose]()¶

[asyncDispose](): Promise<void>

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:216

Returns¶

Promise<void>

Inherited from¶

IfcOpenshellFile.[asyncDispose]

[dispose]()¶

[dispose](): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:215

Returns¶

void

Inherited from¶

IfcOpenshellFile.[dispose]

add()¶

add(entity, instanceId?): EntityInstance

Defined in: ifcopenshell-js/src/file.ts:87

Add an entity, assigning a new id unless instanceId is given explicitly.

Parameters¶
entity¶

EntityInstance

instanceId?¶

number = -1

Returns¶

EntityInstance

Overrides¶

IfcOpenshellFile.add

addEntity()¶

addEntity(instance, id): IfcOpenshellInstance

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:218

Parameters¶
instance¶

IfcOpenshellInstance

id¶

number

Returns¶

IfcOpenshellInstance

Inherited from¶

IfcOpenshellFile.addEntity

addTypeRef()¶

addTypeRef(new_entity): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:219

Parameters¶
new_entity¶

IfcOpenshellInstance

Returns¶

void

Inherited from¶

IfcOpenshellFile.addTypeRef

batch()¶

batch(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:220

Returns¶

void

Inherited from¶

IfcOpenshellFile.batch

buildInverses()¶
Call Signature¶

buildInverses(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:221

Returns¶

void

Inherited from¶

IfcOpenshellFile.buildInverses

Call Signature¶

buildInverses(entity): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:222

Parameters¶
entity¶

IfcOpenshellInstance

Returns¶

void

Inherited from¶

IfcOpenshellFile.buildInverses

bypassType()¶

bypassType(type_name): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:227

Parameters¶
type_name¶

string

Returns¶

void

Inherited from¶

IfcOpenshellFile.bypassType

create()¶

create(ifcClass, attributes?): EntityInstance

Defined in: ifcopenshell-js/src/file.ts:69

Create an entity with any of its IFC attributes, using their schema names.

Parameters¶
ifcClass¶

string

attributes?¶

Record<string, AttributeValueType> = {}

Returns¶

EntityInstance

createByDeclaration()¶

createByDeclaration(declaration, instance_id): IfcOpenshellInstance

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:228

Parameters¶
declaration¶

IfcOpenshellDeclaration

instance_id¶

number

Returns¶

IfcOpenshellInstance

Inherited from¶

IfcOpenshellFile.createByDeclaration

createEntityByName()¶

createEntityByName(type_name): IfcOpenshellInstance

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:229

Parameters¶
type_name¶

string

Returns¶

IfcOpenshellInstance

Inherited from¶

IfcOpenshellFile.createEntityByName

createEntityByNameWithId()¶

createEntityByNameWithId(type_name, id): IfcOpenshellInstance

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:230

Parameters¶
type_name¶

string

id¶

number

Returns¶

IfcOpenshellInstance

Inherited from¶

IfcOpenshellFile.createEntityByNameWithId

createTimestamp()¶

createTimestamp(): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:231

Returns¶

string

Inherited from¶

IfcOpenshellFile.createTimestamp

destroy()¶

destroy(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:213

Returns¶

void

Inherited from¶

IfcOpenshellFile.destroy

dispose()¶

dispose(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:214

Returns¶

void

Inherited from¶

IfcOpenshellFile.dispose

entityNames()¶

entityNames(): number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:232

Returns¶

number[]

Inherited from¶

IfcOpenshellFile.entityNames

filePointer()¶

filePointer(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:233

Returns¶

number

Inherited from¶

IfcOpenshellFile.filePointer

freshId()¶

freshId(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:234

Returns¶

number

Inherited from¶

IfcOpenshellFile.freshId

getInverse()¶
Call Signature¶

getInverse(entity, options): Set<EntityInstance>

Defined in: ifcopenshell-js/src/file.ts:93

Parameters¶
entity¶

EntityInstance

options¶
allowDuplicate?¶

false

withAttributeIndices?¶

false

Returns¶

Set<EntityInstance>

Call Signature¶

getInverse(entity, options): [EntityInstance, number][]

Defined in: ifcopenshell-js/src/file.ts:94

Parameters¶
entity¶

EntityInstance

options¶
allowDuplicate¶

true

withAttributeIndices¶

true

Returns¶

[EntityInstance, number][]

Call Signature¶

getInverse(entity, options): EntityInstance[]

Defined in: ifcopenshell-js/src/file.ts:95

Parameters¶
entity¶

EntityInstance

options¶
allowDuplicate¶

true

withAttributeIndices?¶

false

Returns¶

EntityInstance[]

Call Signature¶

getInverse(entity): Set<EntityInstance>

Defined in: ifcopenshell-js/src/file.ts:96

Parameters¶
entity¶

EntityInstance

Returns¶

Set<EntityInstance>

Call Signature¶

getInverse(entity, options): EntityInstance[] | Set<EntityInstance> | [EntityInstance, number][]

Defined in: ifcopenshell-js/src/file.ts:97

Parameters¶
entity¶

EntityInstance

options¶

GetInverseOptions

Returns¶

EntityInstance[] | Set<EntityInstance> | [EntityInstance, number][]

getInverseIndices()¶

getInverseIndices(instance): number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:236

Parameters¶
instance¶

IfcOpenshellInstance

Returns¶

number[]

Inherited from¶

IfcOpenshellFile.getInverseIndices

getInverseIndicesById()¶

getInverseIndicesById(instance_id): number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:237

Parameters¶
instance_id¶

number

Returns¶

number[]

Inherited from¶

IfcOpenshellFile.getInverseIndicesById

getInverseList()¶

getInverseList(instance): IfcOpenshellInstance[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:235

Parameters¶
instance¶

IfcOpenshellInstance

Returns¶

IfcOpenshellInstance[]

Inherited from¶

IfcOpenshellFile.getInverseList

getInversesByDeclaration()¶

getInversesByDeclaration(instance_id, declaration, attribute_index): IfcOpenshellInstance[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:238

Parameters¶
instance_id¶

number

declaration¶

IfcOpenshellDeclaration

attribute_index¶

number

Returns¶

IfcOpenshellInstance[]

Inherited from¶

IfcOpenshellFile.getInversesByDeclaration

getMaxId()¶

getMaxId(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:239

Returns¶

number

Inherited from¶

IfcOpenshellFile.getMaxId

getTotalInverses()¶

getTotalInverses(instance): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:240

Parameters¶
instance¶

IfcOpenshellInstance

Returns¶

number

Inherited from¶

IfcOpenshellFile.getTotalInverses

getTotalInversesById()¶

getTotalInversesById(instance_id): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:241

Parameters¶
instance_id¶

number

Returns¶

number

Inherited from¶

IfcOpenshellFile.getTotalInversesById

getUnit()¶

getUnit(unit_type): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:242

Parameters¶
unit_type¶

string

Returns¶

number

Inherited from¶

IfcOpenshellFile.getUnit

good()¶

good(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:243

Returns¶

number

Inherited from¶

IfcOpenshellFile.good

headerFileDescription()¶

headerFileDescription(): IfcOpenshellInstance | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:245

Returns¶

IfcOpenshellInstance | null

Inherited from¶

IfcOpenshellFile.headerFileDescription

headerFileName()¶

headerFileName(): IfcOpenshellInstance | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:246

Returns¶

IfcOpenshellInstance | null

Inherited from¶

IfcOpenshellFile.headerFileName

headerFileSchema()¶

headerFileSchema(): IfcOpenshellInstance | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:247

Returns¶

IfcOpenshellInstance | null

Inherited from¶

IfcOpenshellFile.headerFileSchema

ifcrootType()¶

ifcrootType(): IfcOpenshellDeclaration | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:248

Returns¶

IfcOpenshellDeclaration | null

Inherited from¶

IfcOpenshellFile.ifcrootType

initialize()¶

initialize(path, type, read_only): boolean

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:249

Parameters¶
path¶

string

type¶

filetype

read_only¶

boolean

Returns¶

boolean

Inherited from¶

IfcOpenshellFile.initialize

instancesByReference()¶

instancesByReference(reference_id): IfcOpenshellInstance[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:250

Parameters¶
reference_id¶

number

Returns¶

IfcOpenshellInstance[]

Inherited from¶

IfcOpenshellFile.instancesByReference

keyValueStoreIter()¶

keyValueStoreIter(prefix): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:251

Parameters¶
prefix¶

string

Returns¶

string[]

Inherited from¶

IfcOpenshellFile.keyValueStoreIter

keyValueStoreQuery()¶

keyValueStoreQuery(key): number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:252

Parameters¶
key¶

string

Returns¶

number[]

Inherited from¶

IfcOpenshellFile.keyValueStoreQuery

processDeletionInverse()¶

processDeletionInverse(entity): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:253

Parameters¶
entity¶

IfcOpenshellInstance

Returns¶

void

Inherited from¶

IfcOpenshellFile.processDeletionInverse

recalculateIdCounter()¶

recalculateIdCounter(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:254

Returns¶

void

Inherited from¶

IfcOpenshellFile.recalculateIdCounter

remove()¶

remove(entity): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:255

Parameters¶
entity¶

IfcOpenshellInstance

Returns¶

void

Inherited from¶

IfcOpenshellFile.remove

removeTypeRef()¶

removeTypeRef(new_entity): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:256

Parameters¶
new_entity¶

IfcOpenshellInstance

Returns¶

void

Inherited from¶

IfcOpenshellFile.removeTypeRef

resetIdentityCache()¶

resetIdentityCache(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:257

Returns¶

void

Inherited from¶

IfcOpenshellFile.resetIdentityCache

schema()¶

schema(): string

Defined in: ifcopenshell-js/src/file.ts:82

General IFC schema version, without addendum or technical corrigendum suffixes.

Returns¶

string

schemaDefinition()¶

schemaDefinition(): IfcOpenshellSchema | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:258

Returns¶

IfcOpenshellSchema | null

Inherited from¶

IfcOpenshellFile.schemaDefinition

schemaIdentifier()¶

schemaIdentifier(): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:259

Returns¶

string

Inherited from¶

IfcOpenshellFile.schemaIdentifier

storageMode()¶

storageMode(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:260

Returns¶

number

Inherited from¶

IfcOpenshellFile.storageMode

toString()¶

toString(): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:261

Returns¶

string

Inherited from¶

IfcOpenshellFile.toString

types()¶

types(): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:264

Returns¶

string[]

Inherited from¶

IfcOpenshellFile.types

unbatch()¶

unbatch(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:265

Returns¶

void

Inherited from¶

IfcOpenshellFile.unbatch

write()¶

write(path): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:266

Parameters¶
path¶

string

Returns¶

void

Inherited from¶

IfcOpenshellFile.write

open()¶

static open(bytes, filename?, options?): File

Defined in: ifcopenshell-js/src/file.ts:31

Open IFC STEP bytes and retain ownership of the native file.

Parameters¶
bytes¶

ArrayBuffer | Uint8Array<ArrayBufferLike>

filename?¶

string

options?¶

OpenOptions = {}

Returns¶

File

IfcOpenShellError¶

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:22

Kinds and codes are stable identifiers. Message is diagnostic only.

Extends¶

  • Error

Constructors¶

Constructor¶

new IfcOpenShellError(message, cause?): IfcOpenShellError

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:25

Parameters¶
message¶

string

cause?¶

unknown

Returns¶

IfcOpenShellError

Overrides¶

Error.constructor

Constructor¶

new IfcOpenShellError(kind, code, message, cause?): IfcOpenShellError

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:26

Parameters¶
kind¶

IfcOpenShellErrorKind

code¶

IfcOpenShellErrorCode

message¶

string

cause?¶

unknown

Returns¶

IfcOpenShellError

Overrides¶

Error.constructor

Properties¶

code¶

readonly code: IfcOpenShellErrorCode

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:24

kind¶

readonly kind: IfcOpenShellErrorKind

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:23

Interfaces¶

EmscriptenFS¶

Defined in: ifcopenshell-js/src/types.ts:15

Subset of the Emscripten MEMFS filesystem API exposed by the underlying WASM runtime. Used by higher-level wrappers (for example the SVG/TTL serializers) to read, write, and delete files inside the virtual filesystem that the C++ layer writes to.

Methods¶

analyzePath()¶

analyzePath(path): object

Defined in: ifcopenshell-js/src/types.ts:38

Return whether a path exists in MEMFS.

Parameters¶
path¶

string

Returns¶

object

exists¶

exists: boolean

object?¶

optional object?: object

readFile()¶

readFile(path, opts?): string | Uint8Array<ArrayBufferLike>

Defined in: ifcopenshell-js/src/types.ts:34

Read a virtual filesystem file.

When opts.encoding === 'utf8' the file is decoded to a string; otherwise a Uint8Array of the raw bytes is returned.

Parameters¶
path¶

string

opts?¶
encoding?¶

string

flags?¶

string

Returns¶

string | Uint8Array<ArrayBufferLike>

writeFile()¶

writeFile(path, data, opts?): void

Defined in: ifcopenshell-js/src/types.ts:23

Write data to a virtual filesystem path.

Parameters¶
path¶

string

Destination path inside MEMFS.

data¶

string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>

String or byte view to write.

opts?¶

Optional flags (e.g. { flags: 'w' }).

flags?¶

string

Returns¶

void

EntityInstanceInfo¶

Defined in: ifcopenshell-js/src/entity_instance.ts:13

Flat dictionary returned by EntityInstance.getInfo().

Type Parameters¶

T¶

T = never

Indexable¶

[attribute: string]: EntityInfoValue<T> | undefined

Properties¶

id?¶

optional id?: number

Defined in: ifcopenshell-js/src/entity_instance.ts:14

type¶

type: string

Defined in: ifcopenshell-js/src/entity_instance.ts:15

GetInfoOptions¶

Defined in: ifcopenshell-js/src/entity_instance.ts:19

Type Parameters¶

T¶

T = EntityInstanceInfo

Properties¶

ignore?¶

optional ignore?: readonly string[]

Defined in: ifcopenshell-js/src/entity_instance.ts:22

includeIdentifier?¶

optional includeIdentifier?: boolean

Defined in: ifcopenshell-js/src/entity_instance.ts:20

recursive?¶

optional recursive?: boolean

Defined in: ifcopenshell-js/src/entity_instance.ts:21

returnType?¶

optional returnType?: (info) => T

Defined in: ifcopenshell-js/src/entity_instance.ts:23

Parameters¶
info¶

EntityInstanceInfo<unknown>

Returns¶

T

GetInverseOptions¶

Defined in: ifcopenshell-js/src/file.ts:14

Properties¶

allowDuplicate?¶

optional allowDuplicate?: boolean

Defined in: ifcopenshell-js/src/file.ts:15

withAttributeIndices?¶

optional withAttributeIndices?: boolean

Defined in: ifcopenshell-js/src/file.ts:16

IfcOpenShell¶

Defined in: ifcopenshell-js/src/init.ts:21

Initialized IfcOpenShell runtime and its ergonomic low-level API.

Properties¶

fs¶

readonly fs: EmscriptenFS | null

Defined in: ifcopenshell-js/src/init.ts:23

raw¶

readonly raw: IfcOpenshellModule

Defined in: ifcopenshell-js/src/init.ts:22

Methods¶

loadedPlugins()¶

loadedPlugins(): string[]

Defined in: ifcopenshell-js/src/init.ts:25

Returns¶

string[]

loadPlugin()¶

loadPlugin(kind, id): Promise<void>

Defined in: ifcopenshell-js/src/init.ts:24

Parameters¶
kind¶

PluginKind

id¶

string

Returns¶

Promise<void>

IfcOpenshellModule¶

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1154

Properties¶

geom¶

geom: IfcOpenshellGeomModule

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1225

IfcOpenshellAggregationType¶

IfcOpenshellAggregationType: typeof IfcOpenshellAggregationType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1155

IfcOpenshellAttribute¶

IfcOpenshellAttribute: typeof IfcOpenshellAttribute

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1156

IfcOpenshellDeclaration¶

IfcOpenshellDeclaration: typeof IfcOpenshellDeclaration

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1157

IfcOpenshellEntity¶

IfcOpenshellEntity: typeof IfcOpenshellEntity

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1158

IfcOpenshellEnumeration¶

IfcOpenshellEnumeration: typeof IfcOpenshellEnumeration

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1159

IfcOpenshellFile¶

IfcOpenshellFile: typeof IfcOpenshellFile

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1163

IfcOpenshellFileDescription¶

IfcOpenshellFileDescription: typeof IfcOpenshellFileDescription

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1160

IfcOpenshellFileName¶

IfcOpenshellFileName: typeof IfcOpenshellFileName

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1161

IfcOpenshellFileSchema¶

IfcOpenshellFileSchema: typeof IfcOpenshellFileSchema

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1162

IfcOpenshellGeomBrepElement¶

IfcOpenshellGeomBrepElement: typeof IfcOpenshellGeomBrepElement

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1164

IfcOpenshellGeomBrepRepresentation¶

IfcOpenshellGeomBrepRepresentation: typeof IfcOpenshellGeomBrepRepresentation

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1165

IfcOpenshellGeomBuffer¶

IfcOpenshellGeomBuffer: typeof IfcOpenshellGeomBuffer

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1166

IfcOpenshellGeomConversionResultShape¶

IfcOpenshellGeomConversionResultShape: typeof IfcOpenshellGeomConversionResultShape

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1167

IfcOpenshellGeomElement¶

IfcOpenshellGeomElement: typeof IfcOpenshellGeomElement

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1168

IfcOpenshellGeomFunctionItemEvaluator¶

IfcOpenshellGeomFunctionItemEvaluator: typeof IfcOpenshellGeomFunctionItemEvaluator

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1169

IfcOpenshellGeomGeometrySerializer¶

IfcOpenshellGeomGeometrySerializer: typeof IfcOpenshellGeomGeometrySerializer

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1170

IfcOpenshellGeomIterator¶

IfcOpenshellGeomIterator: typeof IfcOpenshellGeomIterator

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1171

IfcOpenshellGeomOpaqueNumber¶

IfcOpenshellGeomOpaqueNumber: typeof IfcOpenshellGeomOpaqueNumber

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1172

IfcOpenshellGeomSerialization¶

IfcOpenshellGeomSerialization: typeof IfcOpenshellGeomSerialization

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1173

IfcOpenshellGeomSerializedElement¶

IfcOpenshellGeomSerializedElement: typeof IfcOpenshellGeomSerializedElement

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1174

IfcOpenshellGeomSerializer¶

IfcOpenshellGeomSerializer: typeof IfcOpenshellGeomSerializer

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1175

IfcOpenshellGeomSettings¶

IfcOpenshellGeomSettings: typeof IfcOpenshellGeomSettings

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1176

IfcOpenshellGeomSvgfillPolygon¶

IfcOpenshellGeomSvgfillPolygon: typeof IfcOpenshellGeomSvgfillPolygon

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1177

IfcOpenshellGeomTaxonomyBooleanResult¶

IfcOpenshellGeomTaxonomyBooleanResult: typeof IfcOpenshellGeomTaxonomyBooleanResult

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1178

IfcOpenshellGeomTaxonomyBsplineCurve¶

IfcOpenshellGeomTaxonomyBsplineCurve: typeof IfcOpenshellGeomTaxonomyBsplineCurve

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1179

IfcOpenshellGeomTaxonomyBsplineSurface¶

IfcOpenshellGeomTaxonomyBsplineSurface: typeof IfcOpenshellGeomTaxonomyBsplineSurface

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1180

IfcOpenshellGeomTaxonomyCircle¶

IfcOpenshellGeomTaxonomyCircle: typeof IfcOpenshellGeomTaxonomyCircle

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1181

IfcOpenshellGeomTaxonomyCollection¶

IfcOpenshellGeomTaxonomyCollection: typeof IfcOpenshellGeomTaxonomyCollection

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1182

IfcOpenshellGeomTaxonomyColour¶

IfcOpenshellGeomTaxonomyColour: typeof IfcOpenshellGeomTaxonomyColour

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1183

IfcOpenshellGeomTaxonomyCylinder¶

IfcOpenshellGeomTaxonomyCylinder: typeof IfcOpenshellGeomTaxonomyCylinder

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1184

IfcOpenshellGeomTaxonomyDirection3¶

IfcOpenshellGeomTaxonomyDirection3: typeof IfcOpenshellGeomTaxonomyDirection3

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1185

IfcOpenshellGeomTaxonomyEdge¶

IfcOpenshellGeomTaxonomyEdge: typeof IfcOpenshellGeomTaxonomyEdge

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1186

IfcOpenshellGeomTaxonomyEllipse¶

IfcOpenshellGeomTaxonomyEllipse: typeof IfcOpenshellGeomTaxonomyEllipse

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1187

IfcOpenshellGeomTaxonomyExtrusion¶

IfcOpenshellGeomTaxonomyExtrusion: typeof IfcOpenshellGeomTaxonomyExtrusion

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1188

IfcOpenshellGeomTaxonomyFace¶

IfcOpenshellGeomTaxonomyFace: typeof IfcOpenshellGeomTaxonomyFace

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1189

IfcOpenshellGeomTaxonomyItem¶

IfcOpenshellGeomTaxonomyItem: typeof IfcOpenshellGeomTaxonomyItem

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1190

IfcOpenshellGeomTaxonomyLine¶

IfcOpenshellGeomTaxonomyLine: typeof IfcOpenshellGeomTaxonomyLine

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1191

IfcOpenshellGeomTaxonomyLoft¶

IfcOpenshellGeomTaxonomyLoft: typeof IfcOpenshellGeomTaxonomyLoft

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1192

IfcOpenshellGeomTaxonomyLoop¶

IfcOpenshellGeomTaxonomyLoop: typeof IfcOpenshellGeomTaxonomyLoop

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1193

IfcOpenshellGeomTaxonomyMatrix4¶

IfcOpenshellGeomTaxonomyMatrix4: typeof IfcOpenshellGeomTaxonomyMatrix4

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1194

IfcOpenshellGeomTaxonomyNode¶

IfcOpenshellGeomTaxonomyNode: typeof IfcOpenshellGeomTaxonomyNode

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1195

IfcOpenshellGeomTaxonomyOffsetCurve¶

IfcOpenshellGeomTaxonomyOffsetCurve: typeof IfcOpenshellGeomTaxonomyOffsetCurve

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1196

IfcOpenshellGeomTaxonomyPlane¶

IfcOpenshellGeomTaxonomyPlane: typeof IfcOpenshellGeomTaxonomyPlane

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1197

IfcOpenshellGeomTaxonomyPoint3¶

IfcOpenshellGeomTaxonomyPoint3: typeof IfcOpenshellGeomTaxonomyPoint3

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1198

IfcOpenshellGeomTaxonomyRevolve¶

IfcOpenshellGeomTaxonomyRevolve: typeof IfcOpenshellGeomTaxonomyRevolve

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1199

IfcOpenshellGeomTaxonomyShell¶

IfcOpenshellGeomTaxonomyShell: typeof IfcOpenshellGeomTaxonomyShell

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1200

IfcOpenshellGeomTaxonomySolid¶

IfcOpenshellGeomTaxonomySolid: typeof IfcOpenshellGeomTaxonomySolid

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1201

IfcOpenshellGeomTaxonomySphere¶

IfcOpenshellGeomTaxonomySphere: typeof IfcOpenshellGeomTaxonomySphere

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1202

IfcOpenshellGeomTaxonomyStyle¶

IfcOpenshellGeomTaxonomyStyle: typeof IfcOpenshellGeomTaxonomyStyle

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1203

IfcOpenshellGeomTaxonomySweepAlongCurve¶

IfcOpenshellGeomTaxonomySweepAlongCurve: typeof IfcOpenshellGeomTaxonomySweepAlongCurve

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1204

IfcOpenshellGeomTaxonomyTorus¶

IfcOpenshellGeomTaxonomyTorus: typeof IfcOpenshellGeomTaxonomyTorus

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1205

IfcOpenshellGeomTransformation¶

IfcOpenshellGeomTransformation: typeof IfcOpenshellGeomTransformation

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1206

IfcOpenshellGeomTree¶

IfcOpenshellGeomTree: typeof IfcOpenshellGeomTree

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1211

IfcOpenshellGeomTreeClash¶

IfcOpenshellGeomTreeClash: typeof IfcOpenshellGeomTreeClash

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1208

IfcOpenshellGeomTreeClashList¶

IfcOpenshellGeomTreeClashList: typeof IfcOpenshellGeomTreeClashList

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1207

IfcOpenshellGeomTreeRayIntersection¶

IfcOpenshellGeomTreeRayIntersection: typeof IfcOpenshellGeomTreeRayIntersection

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1210

IfcOpenshellGeomTreeRayIntersectionList¶

IfcOpenshellGeomTreeRayIntersectionList: typeof IfcOpenshellGeomTreeRayIntersectionList

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1209

IfcOpenshellGeomTriangulation¶

IfcOpenshellGeomTriangulation: typeof IfcOpenshellGeomTriangulation

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1213

IfcOpenshellGeomTriangulationElement¶

IfcOpenshellGeomTriangulationElement: typeof IfcOpenshellGeomTriangulationElement

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1212

IfcOpenshellHeader¶

IfcOpenshellHeader: typeof IfcOpenshellHeader

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1214

IfcOpenshellInstance¶

IfcOpenshellInstance: typeof IfcOpenshellInstance

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1216

IfcOpenshellInstanceStreamer¶

IfcOpenshellInstanceStreamer: typeof IfcOpenshellInstanceStreamer

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1215

IfcOpenshellInverseAttribute¶

IfcOpenshellInverseAttribute: typeof IfcOpenshellInverseAttribute

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1217

IfcOpenshellNamedType¶

IfcOpenshellNamedType: typeof IfcOpenshellNamedType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1218

IfcOpenshellParameterType¶

IfcOpenshellParameterType: typeof IfcOpenshellParameterType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1219

IfcOpenshellParseInstanceList¶

IfcOpenshellParseInstanceList: typeof IfcOpenshellParseInstanceList

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1220

IfcOpenshellSchema¶

IfcOpenshellSchema: typeof IfcOpenshellSchema

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1221

IfcOpenshellSelectType¶

IfcOpenshellSelectType: typeof IfcOpenshellSelectType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1222

IfcOpenshellSimpleType¶

IfcOpenshellSimpleType: typeof IfcOpenshellSimpleType

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1223

IfcOpenshellTypeDeclaration¶

IfcOpenshellTypeDeclaration: typeof IfcOpenshellTypeDeclaration

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1224

parse¶

parse: IfcOpenshellParseModule

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1226

Methods¶

loadedPlugins()¶

loadedPlugins(): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1228

Returns¶

string[]

loadPlugin()¶

loadPlugin(kind, id): Promise<void>

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1227

Parameters¶
kind¶

"schema" | "kernel" | "mapping" | "tree" | "document" | "geometry_serializer"

id¶

string

Returns¶

Promise<void>

setInstanceFactory()¶

setInstanceFactory(factory): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:1229

Parameters¶
factory¶

(handle) => IfcOpenshellInstance

Returns¶

void

InitOptions¶

Defined in: ifcopenshell-js/src/types.ts:125

Options for init.

Properties¶

pluginLoader?¶

optional pluginLoader?: PluginLoader

Defined in: ifcopenshell-js/src/types.ts:129

Custom plugin loader override. Defaults to the loader supplied by the asset descriptor.

wasmAssets?¶

optional wasmAssets?: WasmAssets

Defined in: ifcopenshell-js/src/types.ts:127

WASM asset configuration.

OpenOptions¶

Defined in: ifcopenshell-js/src/file.ts:7

Options controlling IFC byte-stream loading.

Properties¶

readonly?¶

optional readonly?: boolean

Defined in: ifcopenshell-js/src/file.ts:11

Open the native file in read-only mode when supported.

signal?¶

optional signal?: AbortSignal

Defined in: ifcopenshell-js/src/file.ts:9

Abort opening before native parsing begins.

PluginEntry¶

Defined in: ifcopenshell-js/src/types.ts:45

A single entry in the plugin manifest, describing a loadable side module.

Properties¶

depends?¶

optional depends?: string[]

Defined in: ifcopenshell-js/src/types.ts:49

Plugin keys this entry depends on, e.g. ["kernel:occt"].

wasm¶

wasm: string

Defined in: ifcopenshell-js/src/types.ts:47

Relative path to the .wasm side module (resolved against pluginBaseUrl).

PluginManifest¶

Defined in: ifcopenshell-js/src/types.ts:53

The full plugin manifest (content of ifcopenshell_plugins.json).

Properties¶

document?¶

optional document?: Record<string, PluginEntry>

Defined in: ifcopenshell-js/src/types.ts:57

geometry_serializer?¶

optional geometry_serializer?: Record<string, PluginEntry>

Defined in: ifcopenshell-js/src/types.ts:58

kernel?¶

optional kernel?: Record<string, PluginEntry>

Defined in: ifcopenshell-js/src/types.ts:55

mapping?¶

optional mapping?: Record<string, PluginEntry>

Defined in: ifcopenshell-js/src/types.ts:56

schema?¶

optional schema?: Record<string, PluginEntry>

Defined in: ifcopenshell-js/src/types.ts:54

tree?¶

optional tree?: Record<string, PluginEntry>

Defined in: ifcopenshell-js/src/types.ts:59

WasmAssets¶

Defined in: ifcopenshell-js/src/types.ts:101

Configuration for locating the WASM build artifacts.

Properties¶

apiModuleUrl?¶

optional apiModuleUrl?: string

Defined in: ifcopenshell-js/src/types.ts:116

URL or module specifier for the generated ifcopenshell_api.mjs. Required when createIfcOpenshellModule is not provided.

createIfcOpenshellModule?¶

optional createIfcOpenshellModule?: IfcOpenshellApiFactory

Defined in: ifcopenshell-js/src/types.ts:121

Generated API factory. Bundler-friendly wasm packages should provide this so app bundles do not need runtime string imports for ifcopenshell_api.mjs.

initModule¶

Defined in: ifcopenshell-js/src/types.ts:103

The Emscripten module factory (default export of ifcopenshell_wasm.mjs).

manifest¶

manifest: PluginManifest

Defined in: ifcopenshell-js/src/types.ts:109

Parsed content of ifcopenshell_plugins.json.

pluginBaseUrl¶

pluginBaseUrl: string

Defined in: ifcopenshell-js/src/types.ts:107

Base URL for resolving plugin .wasm paths from the manifest.

pluginLoader?¶

optional pluginLoader?: PluginLoader

Defined in: ifcopenshell-js/src/types.ts:111

Environment-appropriate loader for plugin WASM files.

wasmUrl¶

wasmUrl: string

Defined in: ifcopenshell-js/src/types.ts:105

URL or path to ifcopenshell_wasm.wasm.

Type Aliases¶

AttributeValueType¶

AttributeValueType = NativeAttributeValueType<EntityInstance>

Defined in: ifcopenshell-js/src/entity_instance.ts:8

Values decoded by the native WASM attribute typemap.

EmscriptenModuleFactory¶

EmscriptenModuleFactory = (options?) => Promise<object>

Defined in: ifcopenshell-js/src/types.ts:76

Emscripten module factory — the default export of ifcopenshell_wasm.mjs.

Parameters¶

options?¶

EmscriptenOptions

Returns¶

Promise<object>

EmscriptenOption¶

EmscriptenOption = null | boolean | number | string | EmscriptenOption[] | {[key: string]: EmscriptenOption; } | ((path, prefix) => string)

Defined in: ifcopenshell-js/src/types.ts:63

Recursive value accepted by an Emscripten module factory.

EmscriptenOptions¶

EmscriptenOptions = Record<string, EmscriptenOption>

Defined in: ifcopenshell-js/src/types.ts:73

Emscripten module factory option map.

EntityInfoValue¶

EntityInfoValue<T> = null | boolean | number | bigint | string | EntityInstance | EntityInstanceInfo<T> | T | EntityInfoValue<T>[]

Defined in: ifcopenshell-js/src/entity_instance.ts:10

Type Parameters¶

T¶

T = never

IfcOpenshellApiFactory¶

IfcOpenshellApiFactory = (initModule, wasmUrl?, opts?) => Promise<IfcOpenshellModule>

Defined in: ifcopenshell-js/src/types.ts:79

Generated API factory exported by ifcopenshell_api.mjs.

Parameters¶

initModule¶

EmscriptenModuleFactory

wasmUrl?¶

string

opts?¶
pluginBaseUrl?¶

string

pluginLoader?¶

PluginLoader

pluginManifest?¶

Record<string, Record<string, { depends?: string[]; wasm: string; }>>

Returns¶

Promise<IfcOpenshellModule>

IfcOpenShellErrorCode¶

IfcOpenShellErrorCode = typeof IfcOpenShellErrorCode[keyof typeof IfcOpenShellErrorCode]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:13

IfcOpenShellErrorKind¶

IfcOpenShellErrorKind = typeof IfcOpenShellErrorKind[keyof typeof IfcOpenShellErrorKind]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:5

PluginKind¶

PluginKind = "schema" | "kernel" | "mapping" | "tree" | "document" | "geometry_serializer"

Defined in: ifcopenshell-js/src/types.ts:42

Identifiers for the plugin kinds supported by the WASM loader.

PluginLoader¶

PluginLoader = (url, plugin) => Promise<Uint8Array | ArrayBuffer | ArrayBufferView> | Uint8Array | ArrayBuffer | ArrayBufferView

Defined in: ifcopenshell-js/src/types.ts:95

Custom plugin loader function.

Override this to change how plugin .wasm bytes are fetched. The default loader uses fetch() in the browser and is filesystem-backed in Node.

Parameters¶

url¶

string

plugin¶
entry¶

PluginEntry

id¶

string

kind¶

string

Returns¶

Promise<Uint8Array | ArrayBuffer | ArrayBufferView> | Uint8Array | ArrayBuffer | ArrayBufferView

Ptr¶

Ptr = number

Defined in: ifcopenshell-js/src/types.ts:7

Raw pointer address in WASM linear memory.

Variables¶

ifcopenshell¶

ifcopenshell: IfcOpenshellModule

Defined in: ifcopenshell-js/src/init.ts:64

Native module, available after awaiting init().

IfcOpenShellErrorCode¶

const IfcOpenShellErrorCode: object

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:13

Type Declaration¶

DOMAIN_ERROR¶

readonly DOMAIN_ERROR: 3

INVALID_ARGUMENT¶

readonly INVALID_ARGUMENT: 2

NONE¶

readonly NONE: 0

OPERATION_CANCELLED¶

readonly OPERATION_CANCELLED: 4

UNSPECIFIED¶

readonly UNSPECIFIED: 1

IfcOpenShellErrorKind¶

const IfcOpenShellErrorKind: object

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:5

Type Declaration¶

CANCELLED¶

readonly CANCELLED: 4

NONE¶

readonly NONE: 0

RUNTIME¶

readonly RUNTIME: 1

TYPE¶

readonly TYPE: 3

VALUE¶

readonly VALUE: 2

Functions¶

abortError()¶

abortError(message?, cause?): IfcOpenShellError

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:28

Parameters¶

message?¶

string

cause?¶

unknown

Returns¶

IfcOpenShellError

init()¶

init(options?): Promise<IfcOpenShell>

Defined in: ifcopenshell-js/src/init.ts:45

Initialize the packaged or explicitly configured WASM runtime.

Plugins are loaded lazily through IfcOpenShell.loadPlugin. File and Iterator support explicit disposal; other handles use GC cleanup.

Parameters¶

options?¶

InitOptions = {}

Asset locations and optional plugin-loader overrides.

Returns¶

Promise<IfcOpenShell>

An initialized, frozen runtime facade.

isIfcOpenShellAbortError()¶

isIfcOpenShellAbortError(error): error is IfcOpenShellError

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:29

Parameters¶

error¶

unknown

Returns¶

error is IfcOpenShellError

open()¶

open(bytes, filename?, options?): File

Defined in: ifcopenshell-js/src/file.ts:157

Parse IFC bytes after explicitly loading their schema plugin.

Parameters¶

bytes¶

ArrayBuffer | Uint8Array<ArrayBufferLike>

filename?¶

string

options?¶

OpenOptions

Returns¶

File

schemaByName()¶

schemaByName(name): IfcOpenshellSchema | null

Defined in: ifcopenshell-js/src/init.ts:66

Retrieve the loaded schema declaration by its full identifier.

Parameters¶

name¶

string

Returns¶

IfcOpenshellSchema | null

References¶

ExportOptions¶

Re-exports ExportOptions

ExportResult¶

Re-exports ExportResult

exportToBuffer¶

Re-exports exportToBuffer

OperationProgress¶

Re-exports OperationProgress

SerializerFormat¶

Re-exports SerializerFormat

util¶

Renames and re-exports Utilities