Class FeaturePath

Reads the values of a query's GET columns from its result records

Index

Constructors

Methods

columns firstText queryColumns resolveColumn

Constructors

constructor

new FeaturePath(): FeaturePath
Returns FeaturePath

Methods

`Static`columns

columns(singleFeature: QueryNode, siblings?: QueryNode[]): FeaturePathColumn[]
The columns of one GET feature (usually one; a relation with several sub features gives one per sub feature)
Parameters
- singleFeature: QueryNode
- Optionalsiblings: QueryNode[]
Returns FeaturePathColumn[]
- Defined in BimWorksJsSdk/jssdk.d.ts:1786

`Static`firstText

firstText(ast: QueryNode, record: object): string | null
The text of the first GET column (qid aside) with a plain value in this record, null when there is none
Parameters
- ast: QueryNode
- record: object
Returns string | null
- Defined in BimWorksJsSdk/jssdk.d.ts:1790

`Static`queryColumns

queryColumns(ast: QueryNode): FeaturePathColumn[]
All result columns of a parsed query, in GET order
Parameters
- ast: QueryNode
Returns FeaturePathColumn[]
- Defined in BimWorksJsSdk/jssdk.d.ts:1784

`Static`resolveColumn

resolveColumn(record: object, column: FeaturePathColumn): unknown[]
The values of a column in a result record
Parameters
- record: object
- column: FeaturePathColumn
Returns unknown[]
- Defined in BimWorksJsSdk/jssdk.d.ts:1788