types | References | ArcGIS Maps SDK for JavaScript

Types

import type { AttributeTableElementUnion, NestedAttributeTableElementUnion, CreateTemplateParameters, CreateTableTemplateFromAttributeTableTemplateParameters } from "@arcgis/core/tables/support/types.js";

Type definitions

AttributeTableElementUnion

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

A union of all attribute table elements.

Type: AttributeTableAttachmentElement | AttributeTableFieldElement | AttributeTableGroupElement | AttributeTableRelationshipElement

NestedAttributeTableElementUnion

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

A union of all attribute table elements that are nestable in a group element.

Supertypes: Exclude<AttributeTableElementUnion‚ AttributeTableGroupElement>

CreateTemplateParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Parameters for creating a table template or attribute table template.

layer

Property

Type: unknown

Since: ArcGIS Maps SDK for JavaScript 5.1

Layer from which to generate a default template.

visibleFieldNames

Property

Type: string[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Set of field names used to generate columns. If this parameter is not specified, columns are generated for all fields that are visible by default.

excludeAttachments

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates whether attachments columns should be excluded.

excludeRelationships

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates whether relationship columns should be excluded.

excludedFieldTypesOverride

Property

Type: FieldType[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of field types that specify which types to exclude. The default value is ["geometry", "blob", "raster", "guid", "xml"].

CreateTableTemplateFromAttributeTableTemplateParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Parameters for creating a table template from a provided attribute table template.

layer

Property

Type: unknown

Since: ArcGIS Maps SDK for JavaScript 5.1

Layer used to generate the default template.

template

Property

Type: AttributeTableTemplate

Since: ArcGIS Maps SDK for JavaScript 5.1

Instance of an AttributeTableTemplate used to configure a new TableTemplate.

includeHiddenFields

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates whether columns should be generated for fields without associated attribute table elements.

excludedFieldTypesOverride

Property

Type: FieldType[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"].