INTERFACE
DataField
Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.
link GraphQL Schema definition
- interface DataField {
- # Data category of the field
- : FieldRoleCategory
- # Role of the field: 'dimension', 'measure' or 'unknown'
- : FieldRole
- # Type of the data in the field. See
- # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_typesandroles_datatypes.html
- : FieldDataType
- # The bin field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : BinField_Filter,
- : BinFieldSortOrder,
- : PermissionMode
- ): [BinField]
- # The bin field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : BinField_Filter,
- : BinFieldSortOrder,
- : PermissionMode
- ): BinFieldsConnection
- # Sheets that reference this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : Sheet_Filter,
- : SheetSortOrder,
- : PermissionMode
- ): [Sheet]
- # Sheets that reference this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : Sheet_Filter,
- : SheetSortOrder,
- : PermissionMode
- ): SheetsConnection
- # The set field that this field references
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : SetField_Filter,
- : SetFieldSortOrder,
- : PermissionMode
- ): [SetField]
- # The set field that this field references
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : SetField_Filter,
- : SetFieldSortOrder,
- : PermissionMode
- ): SetFieldsConnection
- # The field that references this remote field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : DatasourceField_Filter,
- : DatasourceFieldSortOrder,
- : PermissionMode
- ): [DatasourceField]
- # The field that references this remote field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : DatasourceField_Filter,
- : DatasourceFieldSortOrder,
- : PermissionMode
- ): DatasourceFieldsConnection
- # The hierarchy field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : HierarchyField_Filter,
- : HierarchyFieldSortOrder,
- : PermissionMode
- ): [HierarchyField]
- # The hierarchy field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : HierarchyField_Filter,
- : HierarchyFieldSortOrder,
- : PermissionMode
- ): HierarchyFieldsConnection
- # The field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : FieldReferencingField_Filter,
- : FieldReferencingFieldSortOrder,
- : PermissionMode
- ): [FieldReferencingField]
- # The field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : FieldReferencingField_Filter,
- : FieldReferencingFieldSortOrder,
- : PermissionMode
- ): FieldReferencingFieldsConnection
- # The data source filters that include this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : DatasourceFilter_Filter,
- : DatasourceFilterSortOrder,
- : PermissionMode
- ): [DatasourceFilter]
- # The data source filters that include this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : DatasourceFilter_Filter,
- : DatasourceFilterSortOrder,
- : PermissionMode
- ): DatasourceFiltersConnection
- # Thie combined set field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : CombinedSetField_Filter,
- : CombinedSetFieldSortOrder,
- : PermissionMode
- ): [CombinedSetField]
- # Thie combined set field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : CombinedSetField_Filter,
- : CombinedSetFieldSortOrder,
- : PermissionMode
- ): CombinedSetFieldsConnection
- # Sheets that reference this data source field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : Sheet_Filter,
- : SheetSortOrder,
- : PermissionMode
- ): [Sheet]
- # Sheets that reference this data source field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : Sheet_Filter,
- : SheetSortOrder,
- : PermissionMode
- ): SheetsConnection
- # A flow output field that wraps this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : FlowFieldOutputField_Filter,
- : FlowFieldOutputFieldSortOrder,
- : PermissionMode
- ): [FlowFieldOutputField]
- # A flow output field that wraps this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : FlowFieldOutputField_Filter,
- : FlowFieldOutputFieldSortOrder,
- : PermissionMode
- ): FlowFieldOutputFieldsConnection
- # The calculated field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : CalculatedField_Filter,
- : CalculatedFieldSortOrder,
- : PermissionMode
- ): [CalculatedField]
- # The calculated field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : CalculatedField_Filter,
- : CalculatedFieldSortOrder,
- : PermissionMode
- ): CalculatedFieldsConnection
- # A flow input field that wraps this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- : FlowFieldInputField_Filter,
- : FlowFieldInputFieldSortOrder
- ): [FlowFieldInputField]
- # A flow input field that wraps this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- : String,
- : Int,
- : Int,
- : FlowFieldInputField_Filter,
- : FlowFieldInputFieldSortOrder
- ): FlowFieldInputFieldsConnection
- # Data source that contains this field
- : Datasource
- # Metric definitions that reference this data source field.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : MetricDefinition_Filter,
- : MetricDefinitionSortOrder,
- : PermissionMode
- ): [MetricDefinition]
- # Metric definitions that reference this data source field.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : MetricDefinition_Filter,
- : MetricDefinitionSortOrder,
- : PermissionMode
- ): MetricDefinitionsConnection
- # The group field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : GroupField_Filter,
- : GroupFieldSortOrder,
- : PermissionMode
- ): [GroupField]
- # The group field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : GroupField_Filter,
- : GroupFieldSortOrder,
- : PermissionMode
- ): GroupFieldsConnection
- # The combined field that references this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : CombinedField_Filter,
- : CombinedFieldSortOrder,
- : PermissionMode
- ): [CombinedField]
- # The combined field that references this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : CombinedField_Filter,
- : CombinedFieldSortOrder,
- : PermissionMode
- ): CombinedFieldsConnection
- # List of lens fields which are derived from this field
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : LensField_Filter,
- : LensFieldSortOrder,
- : PermissionMode
- ): [LensField]
- # List of lens fields which are derived from this field
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- : String,
- : Int,
- : Int,
- : LensField_Filter,
- : LensFieldSortOrder,
- : PermissionMode
- ): LensFieldsConnection
- }
link Require by
- BinFieldGraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html
- CalculatedFieldGraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html
- ColumnFieldColumnFields are a type of field which directly connects to a column in some type of table.
- DataFieldsConnectionConnection Type for DataField
- GroupFieldGraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html