Newer Version Available

This content describes an older version of this product. View Latest

AnalyticsVizField

Represents a Tableau Next viusalization field. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set.

Fields

Field Details
AdHocCalc
Type
textarea
Properties
Create, Nillable, Update
Description
An ad-hoc calculation for the visualization field.
DisplayCategory
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The display category for the visualization field.
Possible values are:
  • Continuous—continuous
  • Discrete—discrete
FieldKey
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The key for for the visualization field.
Function
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The function for the visualization field.
Possible values are:
  • Avg
  • Count
  • CountD
  • DatePartDay
  • DatePartMonth
  • DatePartQuarter
  • DatePartWeek
  • DatePartWeekDay
  • DatePartYear
  • DateTruncDay
  • DateTruncMonth
  • DateTruncQuarter
  • DateTruncWeek
  • DateTruncYear
  • FiscalDatePartMonth
  • FiscalDatePartQuarter
  • FiscalDatePartWeek
  • FiscalDatePartYear
  • FiscalDateTruncMonth
  • FiscalDateTruncQuarter
  • FiscalDateTruncWeek
  • FiscalDateTruncYear
  • Max
  • Mdy
  • Median
  • Min
  • My
  • Stdev
  • Stdevp
  • Sum
  • UserAgg
  • Var
  • Varp
Label
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The label for the visualization field.
Role
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The role for the visualization field.
Possible values are:
  • Dimension
  • Measure
SemanticFieldApiName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The API for the field in the semantic model.
SemanticObjectApiName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The API name for object the field belongs to in the semantic model.
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type for the visualization field.
Possible values are:
  • Field
  • MeasureNames
  • MeasureValues
UniqueIndex
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
The unique index value for the visualization field.
This field is a calculated field.
VisualizationId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the visualization the field belongs to.
This field is a relationship field.
Relationship Name
Visualization
Relationship Type
Master-detail
Refers To
AnalyticsVisualization (the master object)