Class Ifc

API Namespace Ifc is used for IFC related API calls.

Constructors

constructor

new Ifc(): Ifc
Returns Ifc

Methods

compareModels

compareModels(request: CompareModelsRequest): Promise<CompareResult>
Compare two models with a BCOL definition. The result is stored on the server: the same compare again is answered from the store (CompareResult.cached).
Parameters
- request: CompareModelsRequest
Returns Promise<CompareResult>
- Defined in BimWorksJsSdk/jssdk.d.ts:1305

compareObjects

compareObjects(
    left: string | Qid,
    right: string | Qid,
    options?: { bcol?: string; definition?: string },
): Promise<
    {
        changed_features: string[];
        changes: Record<string, unknown>;
        label?: string;
        left: string;
        right: string;
        status: "changed" | "unchanged" | "ignored";
        watched: string[];
    },
>
Compares two chosen objects as a pair, by default with the built-in "everything" definition.
Parameters
- left: string | Qid
- right: string | Qid
- Optionaloptions: { bcol?: string; definition?: string }
Returns Promise<
    {
        changed_features: string[];
        changes: Record<string, unknown>;
        label?: string;
        left: string;
        right: string;
        status: "changed" | "unchanged" | "ignored";
        watched: string[];
    },
>
- Defined in BimWorksJsSdk/jssdk.d.ts:1319

deleteComparePairOverride

deleteComparePairOverride(
uuid: string,
): Promise<{ deleted: boolean; overrides: ComparePairOverride[] }>
Takes a pair fixed by hand away again
Parameters
- uuid: string
Returns Promise<{ deleted: boolean; overrides: ComparePairOverride[] }>
- Defined in BimWorksJsSdk/jssdk.d.ts:1331

downloadConverted

downloadConverted(
    versionUuid: string,
    targetSchema: string,
    options?: { validate?: boolean },
): Promise<ConvertedDownload>
Download a Version converted to another IFC schema. The only supported conversion is IFC2X3 to IFC4. A target schema that the model already has is no error: the result then has no conversion.
Parameters
- versionUuid: string
  The UUID of the Version
- targetSchema: string
  The schema to convert to, for example "IFC4"
- Optionaloptions: { validate?: boolean }
  validate: hold the converted file against the schema check before it is served
Returns Promise<ConvertedDownload>
- Defined in BimWorksJsSdk/jssdk.d.ts:1280

downloadIfcXml

downloadIfcXml(versionUuid: string): Promise<string>
Parameters
- versionUuid: string
Returns Promise<string>
- Defined in BimWorksJsSdk/jssdk.d.ts:1271

downloadOriginalIfc

downloadOriginalIfc(versionUuid: string): Promise<string>
Parameters
- versionUuid: string
Returns Promise<string>
- Defined in BimWorksJsSdk/jssdk.d.ts:1270

exportCompareResult

exportCompareResult(
    resultUuid: string,
    format?: "json" | "xlsx" | "csv" | "bcf",
    categories?: string[],
): Promise<string>
A stored compare result as a download; resolves to a URL valid for a limited time.
Parameters
- resultUuid: string
- Optionalformat: "json" | "xlsx" | "csv" | "bcf"
- Optionalcategories: string[]
Returns Promise<string>
- Defined in BimWorksJsSdk/jssdk.d.ts:1322

exportIfc

exportIfc(versionUuids: Iterable<string>, query?: string): Promise<string>
Export an IFC file from one or multiple models. Optionally a query can be applied.
Parameters
- versionUuids: Iterable<string>
  The Version UUIDs of the models you want to export
- Optionalquery: string
  An optional query to be applied
Returns Promise<string>
A Promise that resolved to a URL, from which the export can be downloaded (limited lifetime)
- Defined in BimWorksJsSdk/jssdk.d.ts:1296

exportIfcBvl

exportIfcBvl(versionUuids: Iterable<string>, bvl: string): Promise<string>
As Ifc.exportIfc, filtering with a BVL script instead of a query; resolves with the download URL
Parameters
- versionUuids: Iterable<string>
- bvl: string
Returns Promise<string>
- Defined in BimWorksJsSdk/jssdk.d.ts:1299

getCompareBul

getCompareBul(
leftVersionUuid: string,
rightVersionUuid: string,
): Promise<CompareBul>
The changes between two versions as BUL on the left one, verified by a dry run (docs/upload-diff-design.md §14)
Parameters
- leftVersionUuid: string
- rightVersionUuid: string
Returns Promise<CompareBul>
- Defined in BimWorksJsSdk/jssdk.d.ts:1337

getCompareResult

getCompareResult(
resultUuid: string,
options?: CompareOptions,
): Promise<CompareResult>
Read a stored compare result, or its status while it is computed.
Parameters
- resultUuid: string
- Optionaloptions: CompareOptions
Returns Promise<CompareResult>
- Defined in BimWorksJsSdk/jssdk.d.ts:1310

getMatchCandidates

getMatchCandidates(
    resultUuid: string,
    options?: {
        leftOids?: number[];
        leftQids?: (string | Qid)[];
        limit?: number;
        radiusMm?: number;
    },
): Promise<MatchCandidates>
Per removed object of a stored compare, the added objects that could be it, best first
Parameters
- resultUuid: string
- Optionaloptions: {
      leftOids?: number[];
      leftQids?: (string | Qid)[];
      limit?: number;
      radiusMm?: number;
  }
Returns Promise<MatchCandidates>
- Defined in BimWorksJsSdk/jssdk.d.ts:1334

getSchemaConversionReport

getSchemaConversionReport(
    versionUuid: string,
    targetSchema?: string,
    format?: "json" | "markdown",
): Promise<
    {
        conversion?: SchemaConversionSummary;
        detail_log?: boolean;
        markdown?: string;
        report?: unknown;
    },
>
The log of a schema conversion. Reads a log, converts nothing.
Parameters
- versionUuid: string
  The UUID of the Version
- OptionaltargetSchema: string
  Only for a converted download, the schema it was converted to
- Optionalformat: "json" | "markdown"
  "json" (default) or "markdown"
Returns Promise<
    {
        conversion?: SchemaConversionSummary;
        detail_log?: boolean;
        markdown?: string;
        report?: unknown;
    },
>
- Defined in BimWorksJsSdk/jssdk.d.ts:1288

listComparePairOverrides

listComparePairOverrides(
left: string,
right: string,
): Promise<ComparePairOverride[]>
The pairs fixed by hand for two versions
Parameters
- left: string
- right: string
Returns Promise<ComparePairOverride[]>
- Defined in BimWorksJsSdk/jssdk.d.ts:1325

listUsedIfcProductTypes

listUsedIfcProductTypes(versionUuids: Iterable<string>): Promise<unknown>
Parameters
- versionUuids: Iterable<string>
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:1269

mapQids

mapQids(
    request: {
        all?: boolean;
        from: string;
        oids?: number[];
        qids?: string[];
        to: string;
        via?: string;
    },
): Promise<
    {
        from_version: string;
        matchers: string[];
        pairs: { from: number[]; matched_by: number[]; to: number[] };
        result_uuid: string;
        to_version: string;
        unmatched: number[];
    },
>
Maps objects of one version to their counterparts in another, for re-pointing stored references.
Parameters
- request: {
      all?: boolean;
      from: string;
      oids?: number[];
      qids?: string[];
      to: string;
      via?: string;
  }
Returns Promise<
    {
        from_version: string;
        matchers: string[];
        pairs: { from: number[]; matched_by: number[]; to: number[] };
        result_uuid: string;
        to_version: string;
        unmatched: number[];
    },
>
- Defined in BimWorksJsSdk/jssdk.d.ts:1316

recordUploadAsTransaction

recordUploadAsTransaction(
    versionUuid: string,
    comment?: string,
): Promise<
    {
        node: Record<string, unknown>;
        replaced_version_uuid: string;
        transaction: {
            transaction_uuid: string;
            version: number;
            version_uuid: string;
        };
    },
>
Replaces an upload by a transaction with the same changes on the version before it; the new version takes the upload's number
Parameters
- versionUuid: string
- Optionalcomment: string
Returns Promise<
    {
        node: Record<string, unknown>;
        replaced_version_uuid: string;
        transaction: {
            transaction_uuid: string;
            version: number;
            version_uuid: string;
        };
    },
>
- Defined in BimWorksJsSdk/jssdk.d.ts:1340

setComparePairOverride

setComparePairOverride(
    override: {
        kind: "removed" | "pair" | "added";
        left: string;
        leftOid?: number;
        note?: string;
        right: string;
        rightOid?: number;
    },
): Promise<
    { override: ComparePairOverride; overrides: ComparePairOverride[] },
>
Links two objects as one, or confirms an object as really removed or added, for every compare of the two versions
Parameters
- override: {
      kind: "removed" | "pair" | "added";
      left: string;
      leftOid?: number;
      note?: string;
      right: string;
      rightOid?: number;
  }
Returns Promise<{ override: ComparePairOverride; overrides: ComparePairOverride[] }>
- Defined in BimWorksJsSdk/jssdk.d.ts:1328

versionChanges

versionChanges(
versionUuids: string | string[],
options?: { onlyStored?: boolean },
): Promise<VersionChange[]>
What changed in versions since the versions before them (the built-in Default compare with the predecessor).
Parameters
- versionUuids: string | string[]
- Optionaloptions: { onlyStored?: boolean }
Returns Promise<VersionChange[]>
- Defined in BimWorksJsSdk/jssdk.d.ts:1313

Class Ifc

Index

Constructors

Methods

Constructors

constructor

Returns Ifc

Methods

compareModels

Parameters

Returns Promise<CompareResult>

compareObjects

Parameters

Returns Promise< { changed_features: string[]; changes: Record<string, unknown>; label?: string; left: string; right: string; status: "changed" | "unchanged" | "ignored"; watched: string[]; },>

deleteComparePairOverride

Parameters

Returns Promise<{ deleted: boolean; overrides: ComparePairOverride[] }>

downloadConverted

Parameters

Returns Promise<ConvertedDownload>

downloadIfcXml

Parameters

Returns Promise<string>

downloadOriginalIfc

Parameters

Returns Promise<string>

exportCompareResult

Parameters

Returns Promise<string>

exportIfc

Parameters

Returns Promise<string>

exportIfcBvl

Parameters

Returns Promise<string>

getCompareBul

Parameters

Returns Promise<CompareBul>

getCompareResult

Parameters

Returns Promise<CompareResult>

getMatchCandidates

Parameters

Returns Promise<MatchCandidates>

getSchemaConversionReport

Parameters

Returns Promise< { conversion?: SchemaConversionSummary; detail_log?: boolean; markdown?: string; report?: unknown; },>

listComparePairOverrides

Parameters

Returns Promise<ComparePairOverride[]>

listUsedIfcProductTypes

Parameters

Returns Promise<unknown>

mapQids

Parameters

Returns Promise< { from_version: string; matchers: string[]; pairs: { from: number[]; matched_by: number[]; to: number[] }; result_uuid: string; to_version: string; unmatched: number[]; },>

recordUploadAsTransaction

Parameters

Returns Promise< { node: Record<string, unknown>; replaced_version_uuid: string; transaction: { transaction_uuid: string; version: number; version_uuid: string; }; },>

setComparePairOverride

Parameters

Returns Promise<{ override: ComparePairOverride; overrides: ComparePairOverride[] }>

versionChanges

Parameters

Returns Promise<VersionChange[]>

Settings

On This Page

Returns Promise<
{
changed_features: string[];
changes: Record<string, unknown>;
label?: string;
left: string;
right: string;
status: "changed" | "unchanged" | "ignored";
watched: string[];
},
>

Returns Promise<
{
conversion?: SchemaConversionSummary;
detail_log?: boolean;
markdown?: string;
report?: unknown;
},
>

Returns Promise<
{
from_version: string;
matchers: string[];
pairs: { from: number[]; matched_by: number[]; to: number[] };
result_uuid: string;
to_version: string;
unmatched: number[];
},
>

Returns Promise<
{
node: Record<string, unknown>;
replaced_version_uuid: string;
transaction: {
transaction_uuid: string;
version: number;
version_uuid: string;
};
},
>