Skip to main content Skip to complementary content

IBNFDef Interface

Namespace: Qlik.Engine
Assembly: Qlik.Engine.dll

Syntax

[ValueClass]
public interface IBNFDef

Properties

Name Description
AggrFunc

If set to true, the definition is related to an aggregation function.

This parameter is optional. The default value is false.

JSON property name: qAggrFunc

Bnf

Array of token references that all together build up the definition of the current token.

Generally, if the array is not empty, the definition is a BNF rule (qIsBnfRule is set to true). However, some BNF rules do have an empty array (qIsBnfRule is set to true, but qBnf is empty).

JSON property name: qBnf

BnfLiteral

If set to true, the definition specifies a literal token.

This parameter is optional. The default value is false.

JSON property name: qBnfLiteral

ControlStatement

If set to true, the definition specifies a control statement.

This parameter is optional. The default value is false.

JSON property name: qControlStatement

Depr

Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use).

If set to true, the script statement or the function is not recommended for use in Qlik Sense.

This parameter is optional. The default value is false.

JSON property name: qDepr

FG

Group of the function.

JSON property name: qFG

FGList

List of groups the function belongs to.

JSON property name: qFGList

FieldFlag

If set to true, the definition is related to a field.

This parameter is optional. The default value is false.

JSON property name: qFieldFlag

HelpId

Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name.

Is not used in Qlik Sense.

JSON property name: qHelpId

IsBnfRule

If set to true, a list of related rule tokens is assigned to qBnf .

This parameter is optional. The default value is false.

JSON property name: qIsBnfRule

MT

Type of the data.

JSON property name: qMT

Name

Token name.

One of:

* A rule name

* An identifier

* A literal value

JSON property name: qName

Nbr

Number of the current token definition.

JSON property name: qNbr

PNbr

Number of the parent rule definition.

JSON property name: qPNbr

QvFunc

If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function.

This parameter is optional. The default value is false.

JSON property name: qQvFunc

ScriptStatement

If set to true, the definition specifies a script statement.

This parameter is optional. The default value is false.

JSON property name: qScriptStatement

Str

Literal string of the token.

Examples: 'Round' and '('.

JSON property name: qStr

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!