Class FamilyTable

Hierarchy

FamilyTable

Implements

IFamilyTable

Index

Constructors

Methods

get getAll getAllElementIndex getAllFamilyCategoryIndex getAllIsInPlace getAllIsSystemFamily getAllStructuralMaterialType getAllStructuralSectionShape getCount getElement getElementIndex getFamilyCategory getFamilyCategoryIndex getIsInPlace getIsSystemFamily getStructuralMaterialType getStructuralSectionShape createFromDocument

Constructors

constructor

new FamilyTable(): FamilyTable
Returns FamilyTable

Methods

get

get(familyIndex: number): Promise<IFamily>
Parameters
- familyIndex: number
Returns Promise<IFamily>
Implementation of IFamilyTable.get
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1192

getAll

getAll(): Promise<IFamily[]>
Returns Promise<IFamily[]>
Implementation of IFamilyTable.getAll
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1193

getAllElementIndex

getAllElementIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyTable.getAllElementIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1206

getAllFamilyCategoryIndex

getAllFamilyCategoryIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyTable.getAllFamilyCategoryIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1203

getAllIsInPlace

getAllIsInPlace(): Promise<boolean[]>
Returns Promise<boolean[]>
Implementation of IFamilyTable.getAllIsInPlace
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1201

getAllIsSystemFamily

getAllIsSystemFamily(): Promise<boolean[]>
Returns Promise<boolean[]>
Implementation of IFamilyTable.getAllIsSystemFamily
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1199

getAllStructuralMaterialType

getAllStructuralMaterialType(): Promise<string[]>
Returns Promise<string[]>
Implementation of IFamilyTable.getAllStructuralMaterialType
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1195

getAllStructuralSectionShape

getAllStructuralSectionShape(): Promise<string[]>
Returns Promise<string[]>
Implementation of IFamilyTable.getAllStructuralSectionShape
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1197

getCount

getCount(): Promise<number>
Returns Promise<number>
Implementation of IFamilyTable.getCount
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1191

getElement

getElement(familyIndex: number): Promise<IElement>
Parameters
- familyIndex: number
Returns Promise<IElement>
Implementation of IFamilyTable.getElement
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1207

getElementIndex

getElementIndex(familyIndex: number): Promise<number>
Parameters
- familyIndex: number
Returns Promise<number>
Implementation of IFamilyTable.getElementIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1205

getFamilyCategory

getFamilyCategory(familyIndex: number): Promise<ICategory>
Parameters
- familyIndex: number
Returns Promise<ICategory>
Implementation of IFamilyTable.getFamilyCategory
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1204

getFamilyCategoryIndex

getFamilyCategoryIndex(familyIndex: number): Promise<number>
Parameters
- familyIndex: number
Returns Promise<number>
Implementation of IFamilyTable.getFamilyCategoryIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1202

getIsInPlace

getIsInPlace(familyIndex: number): Promise<boolean>
Parameters
- familyIndex: number
Returns Promise<boolean>
Implementation of IFamilyTable.getIsInPlace
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1200

getIsSystemFamily

getIsSystemFamily(familyIndex: number): Promise<boolean>
Parameters
- familyIndex: number
Returns Promise<boolean>
Implementation of IFamilyTable.getIsSystemFamily
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1198

getStructuralMaterialType

getStructuralMaterialType(familyIndex: number): Promise<string>
Parameters
- familyIndex: number
Returns Promise<string>
Implementation of IFamilyTable.getStructuralMaterialType
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1194

getStructuralSectionShape

getStructuralSectionShape(familyIndex: number): Promise<string>
Parameters
- familyIndex: number
Returns Promise<string>
Implementation of IFamilyTable.getStructuralSectionShape
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1196

`Static` createFromDocument

createFromDocument(document: VimDocument): Promise<IFamilyTable>
Parameters
- document: VimDocument
Returns Promise<IFamilyTable>
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1190

Generated using TypeDoc