BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Class QueryHelper

    Builders and transformations for parsed BQL queries (the JSON form): the conditions the BIM.works UI creates when a feature is clicked, and helpers to adapt a query before it runs.

    Index

    Constructors

    constructor

    Methods

    addFeatureIfNotExists and attributeExpression augmentQueryForVisualization buildingQidEqual buildingStoreyQidEqual calculatedEqual classificationEqualIdentification classificationEqualItemReference classificationEqualLocation classificationEqualName classificationSystemFieldEqual collectParameters createCollectQid createCountQid createExpressionFromObject createNameFeature createQidFeature expressionToBql fromQids hasPropertySet hasQuantitySet isQuantityKey layerEqual mapParameters materialEqual modelEquals modelHeaderFeatureEquals not projectQidEqual propertyEqual qidExpression quantityEqual quantityFigureQuery removeAllAggregateFeatures representationItemEqual representationTypeEqual siteQidEqual systemNameEqual toParameterValues typeAttributeExpression typeCondition typeObjectQidEqual typePropertyEqual typeQuantityEqual zoneNameEqual

    Constructors

    Methods

    • Parameters

      • name: string
      • value: unknown
      • OptionalcaseSensitive: boolean

      Returns QueryNode

    • Adds what the viewers need to show the result (qids) to a query

      Parameters

      Returns QueryNode

    • Objects located in the building with this qid

      Parameters

      • qid: string | Qid

      Returns QueryNode

    • Objects located on the building storey with this qid

      Parameters

      • qid: string | Qid

      Returns QueryNode

    • Parameters

      • path: string
      • key: string
      • value: unknown

      Returns QueryNode

    • Parameters

      • identification: string

      Returns QueryNode

    • Parameters

      • itemReference: string

      Returns QueryNode

    • Parameters

      • location: string

      Returns QueryNode

    • Parameters

      • name: string

      Returns QueryNode

    • Objects whose classification belongs to a classification system whose field (name, edition, source) equals the value

      Parameters

      • field: string
      • value: string

      Returns QueryNode

    • The $name parameters of a parsed, unbound query, each once: kind is one of qids | in | types | range | range-from | range-to | number | scalar | string | length; a BETWEEN with both bounds parameterized is one "range" entry with fromName and toName instead of name

      Parameters

      Returns { fromName?: string; kind: string; name?: string; toName?: string }[]

    • Parameters

      • object: object

      Returns QueryNode

    • A whole query with this expression as its WHERE

      Parameters

      Returns QueryNode

    • The BQL condition qid IN (...)

      Parameters

      • qids: (string | Qid)[]

      Returns string

    • Objects that have a property set with this name, whatever is in it

      Parameters

      • name: string

      Returns QueryNode

    • Objects that have a quantity set with this name, whatever is in it

      Parameters

      • name: string

      Returns QueryNode

    • Whether a quantity figure name is a calculated quantity key

      Parameters

      • name: string

      Returns boolean

    • Parameters

      • name: string

      Returns QueryNode

    • Substitutes parameters in a parsed query; prefer sending query text with parameters

      Parameters

      Returns QueryNode

    • Parameters

      • name: string

      Returns QueryNode

    • Parameters

      • name: string

      Returns QueryNode

    • Parameters

      • name: string
      • value: unknown

      Returns QueryNode

    • Objects located in the project with this qid

      Parameters

      • qid: string | Qid

      Returns QueryNode

    • Parameters

      • name: string
      • value: unknown
      • OptionalsetName: string

        The property set, any set by default

      Returns QueryNode

    • Parameters

      • qid: string | Qid

      Returns QueryNode

    • Parameters

      • name: string
      • value: unknown
      • OptionalsetName: string

        The quantity set, any set by default

      Returns QueryNode

    • The BQL query that fetches one quantity figure of one object

      Parameters

      • qid: string | Qid
      • name: string

      Returns string

    • Removes COUNT/COLLECT and other aggregates from a parsed query

      Parameters

      Returns void

    • Parameters

      • entity: string

      Returns QueryNode

    • Parameters

      • type: string

      Returns QueryNode

    • Objects located on the site with this qid

      Parameters

      • qid: string | Qid

      Returns QueryNode

    • Parameters

      • name: string

      Returns QueryNode

    • A {name -> QidSet | array | scalar} map in the plain-JSON shape the server binds as parameters

      Parameters

      • map: Record<string, unknown>

      Returns Record<string, unknown>

    • Parameters

      • name: string
      • value: unknown
      • OptionalcaseSensitive: boolean

      Returns QueryNode

    • Parameters

      • type: string

      Returns QueryNode

    • Objects whose type object (IfcTypeObject) is the one with this qid

      Parameters

      • qid: string | Qid

      Returns QueryNode

    • Objects whose type object has this property value

      Parameters

      • name: string
      • value: unknown

      Returns QueryNode

    • Objects whose type object has this quantity value

      Parameters

      • name: string
      • value: unknown

      Returns QueryNode

    • Parameters

      • name: string

      Returns QueryNode

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    addFeatureIfNotExistsandattributeExpressionaugmentQueryForVisualizationbuildingQidEqualbuildingStoreyQidEqualcalculatedEqualclassificationEqualIdentificationclassificationEqualItemReferenceclassificationEqualLocationclassificationEqualNameclassificationSystemFieldEqualcollectParameterscreateCollectQidcreateCountQidcreateExpressionFromObjectcreateNameFeaturecreateQidFeatureexpressionToBqlfromQidshasPropertySethasQuantitySetisQuantityKeylayerEqualmapParametersmaterialEqualmodelEqualsmodelHeaderFeatureEqualsnotprojectQidEqualpropertyEqualqidExpressionquantityEqualquantityFigureQueryremoveAllAggregateFeaturesrepresentationItemEqualrepresentationTypeEqualsiteQidEqualsystemNameEqualtoParameterValuestypeAttributeExpressiontypeConditiontypeObjectQidEqualtypePropertyEqualtypeQuantityEqualzoneNameEqual