Type Alias NxVariableListItem<QData>

type NxVariableListItem<QData> = {
    qData?: QData;
    qDefinition?: string;
    qDescription?: string;
    qInfo?: NxInfo;
    qIsConfig?: boolean;
    qIsReserved?: boolean;
    qIsScriptCreated?: boolean;
    qMeta?: NxMeta;
    qName?: string;
}

Type Parameters

  • QData
Index

Properties

qData? qDefinition? qDescription? qInfo? qIsConfig? qIsReserved? qIsScriptCreated? qMeta? qName?

Properties

qData?: QData

Data.

qDefinition?: string

Definition of the variable. It can be a value or an expression.

qDescription?: string

Description of the variable.

qInfo?: NxInfo

Identifier and type of the object. This parameter is mandatory.

qIsConfig?: boolean

If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false.

qIsReserved?: boolean

If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples:

  • ScriptError is a reserved variable, set by the engine.
  • DayNames is a reserved variable, set by the user.
qIsScriptCreated?: boolean

If set to true, it means that the variable was defined via script.

qMeta?: NxMeta

Information about publishing and permissions. This parameter is optional.

qName?: string

Name of the variable.

Settings

Member Visibility

On This Page

Properties