Interface IGenericVariableProperties

interface IGenericVariableProperties {
    qComment?: string;
    qDefinition: string;
    qIncludeInBookmark: boolean;
    qInfo: INxInfo;
    qName: string;
    qNumberPresentation?: IFieldAttributes;
}

Hierarchy

  • IGenericVariableProperties
    • IGenericVariableProperties

Properties

qComment? qDefinition qIncludeInBookmark qInfo qName qNumberPresentation?

Properties

Optional qComment

qComment?: string

Comment related to the variable.

This parameter is optional.

qDefinition

qDefinition: string

Definition of the variable.

qIncludeInBookmark

qIncludeInBookmark: boolean

Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark.

The default value is false.

qInfo

qInfo: INxInfo

Identifier and type of the object.

This parameter is mandatory.

qName

qName: string

Name of the variable. The name must be unique.

This parameter is mandatory.

Optional qNumberPresentation

qNumberPresentation?: IFieldAttributes

Defines the format of the value.

This parameter is optional.

Settings

Member Visibility

Theme

On This Page