@qlik/api reference
Embed
Extend
Manage
APIs
Toolkits
Embed
Extend
Manage
APIs
Toolkits
Preparing search index...
data-sets
DataField
Type Alias DataField
type
DataField
=
{
alias
?:
string
;
dataType
:
FieldDataType
;
description
?:
string
;
encrypted
?:
boolean
;
index
?:
number
;
name
:
string
;
nullable
?:
boolean
;
ordinalPositionInKey
?:
number
;
orphan
?:
boolean
;
primaryKey
?:
boolean
;
properties
?:
Record
<
string
,
unknown
>
;
sensitive
?:
boolean
;
tags
?:
string
[]
;
userTags
?:
UserTag
[]
;
}
Index
Properties
alias?
data
Type
description?
encrypted?
index?
name
nullable?
ordinal
Position
In
Key?
orphan?
primary
Key?
properties?
sensitive?
tags?
user
Tags?
Properties
Optional
alias
alias
?:
string
data
Type
dataType
:
FieldDataType
Optional
description
description
?:
string
Optional
encrypted
encrypted
?:
boolean
Optional
Readonly
index
index
?:
number
name
name
:
string
Optional
nullable
nullable
?:
boolean
Optional
ordinal
Position
In
Key
ordinalPositionInKey
?:
number
Optional
orphan
orphan
?:
boolean
Optional
primary
Key
primaryKey
?:
boolean
Optional
properties
properties
?:
Record
<
string
,
unknown
>
Optional
sensitive
sensitive
?:
boolean
Optional
tags
tags
?:
string
[]
An array of system tags
Optional
user
Tags
userTags
?:
UserTag
[]
An array of user-supplied tags
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
alias
data
Type
description
encrypted
index
name
nullable
ordinal
Position
In
Key
orphan
primary
Key
properties
sensitive
tags
user
Tags
Embed
Extend
Manage
APIs
Toolkits
@qlik/api reference
Loading...
An array of system tags