Miscellaneous

Here are some other useful functions that are available in the console.

Section Builder#

SB.library.getTree#

Description: Fetch the section library tree.

Operation Type: Synchronous

Access: get

Params: null

Sample:

getSectionLibraryTree.js
SB.library.getTree();

Units#

S3D.units.getSystemName#

Description: Gets the name of the current unit system.

Returns: imperial or metric.

Operation Type: Synchronous

Access: get

Params: null

Sample:

getUnitSystem.js
S3D.units.getSystemName();

API#

S3D.API.S3D2API#

Description: Convert an S3D model to SkyCiv's API model format.

Operation Type: Synchronous

Params: S3D.API.S3D2API(structure);

Sample:

convertToApi.js
const structure = S3D.structure.get();
const apiFormattedModel = S3D.API.S3D2API(structure);

S3D.API.API2S3D#

Description: Convert a SkyCiv's API model to the S3D model format.

Operation Type: Synchronous

Params: S3D.API.API2S3D(s3dModel);

Sample:

convertToApi.js
const structure = S3D.structure.get();
const apiFormattedModel = S3D.API.API2S3D(s3dModel);