QuerySelect¶

Type Alias QuerySelect

QuerySelect:
    | "nodeId"
    | "label"
    | "metadata.*"
    | `metadata.${string}`
    | `metadata.structMetaData.${string}`
    | `structMetaData.${string}`
    | "metadata.auxAttributes.*"
    | `metadata.auxAttributes.${string}`
    | `auxAttributes.${string}`
    | "metadata.auxProperties.*"
    | `metadata.auxProperties.${string}`
    | `auxProperties.${string}`
    | "faceHandles"
    | "faceHandle"
    | "extFaceLinks"
    | `property.${Property}`
    | `ancestors.${string}`
    | string & { _?: never }

The QuerySelect type defines the possible selectors of a Query. It is a union of several string literals, but also allows any string for backwards compatibility. For an explanation of the available selectors, see the QueryAPI.

The last entry in the type union is a TypeScript workaround which ensures that the type does not collapse to string. It enables better auto-completion for the defined string literals, while still allowing any string as a selector.

See

QueryAPI