@arcgis/coding-components
Version:
ArcGIS Coding Components
1 lines • 137 kB
JSON
{"name":"@arcgis/coding-components","timestamp":"2026-07-31T00:21:54","compiler":{"name":"@arcgis/lumina-compiler","version":"5.1.15","typescriptVersion":"6.0.2"},"schemaVersion":"2.1.0","modules":[{"kind":"javascript-module","path":"index","sourcePath":"src/index.ts","declarations":[{"kind":"function","name":"getAssetPath","description":"Get a resolved path from where an asset can be loaded.","parameters":[{"name":"suffix","description":"The relative path for the asset.","type":{"text":"string"}}],"return":{"type":{"text":"string"}}},{"kind":"function","name":"setAssetPath","description":"Used to manually set the base path where package assets (like localization\nand icons) can be found.\n\nBy default, the package assets are loaded from\n`https://js.arcgis.com/<version>/<simplified-package-name>/`. We are hosting\nour assets on a CDN (Content Delivery Network) to ensure fast and reliable\naccess. It is CORS-enabled, so you can load the assets from any domain. This\nis the recommended way to load the assets and avoid bundling them with your\napplication.\n\nHowever, if you need to host the assets locally, you can copy them manually\nas part of your build process and use `setAssetPath` to customize where the\nbrowser will load the assets from.","parameters":[{"name":"path","description":"Relative or absolute path to the assets folder.","type":{"text":"URL | string","references":[{"name":"URL","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/URL","start":0,"end":3}]}}],"return":{"type":{"text":"void"}}}]},{"kind":"javascript-module","path":"components/types","sourcePath":"src/components/types.ts","declarations":[{"kind":"interface","name":"Diagnostic","supertypes":[{"name":"Diagnostic","package":"@arcgis/arcade-languageservice"}]},{"kind":"interface","name":"EditorProfileDefinition","description":"Editor Profile definition used for configuring the editor:\n- presenting to the user the Arcade API\n- validating the expression\n- proposing code completion\n- formatting code","members":[{"kind":"field","name":"label","description":"Optional label for the profile. Used in the editor when displaying the variables panel.","type":{"text":"string | undefined"}},{"kind":"field","name":"variables","description":"The collection of variables that will be passed to the expression at execution time.\nThe variable declarations are used to help the editor provide validation and completion.","type":{"text":"ProfileVariable[]","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}},{"kind":"field","name":"apiVersion","description":"The version of the Arcade API that the editor should use during validation and completion.","type":{"text":"string | undefined"}},{"kind":"field","name":"bundles","description":"The Arcade API bundles that the editor should use during validation and completion.","type":{"text":"BundleType[] | undefined","references":[{"name":"BundleType","package":"@arcgis/languages-api-utils","start":0,"end":10}]}},{"kind":"field","name":"additionalApiItems","description":"A collection of additional Arcade API items that will be provided at runtime.","type":{"text":"ApiItem[] | undefined","references":[{"name":"ApiItem","package":"@arcgis/languages-api-utils","start":0,"end":7}]}},{"kind":"field","name":"hiddenApiItems","description":"A collection of api item names to hide.","type":{"text":"string[] | undefined"}}]},{"kind":"interface","name":"IEditorProfileDefinition","deprecated":"since 5.1. Use EditorProfileDefinition instead.","members":[{"kind":"field","name":"label","description":"Optional label for the profile. Used in the editor when displaying the variables panel.","type":{"text":"string | undefined"}},{"kind":"field","name":"variables","description":"The collection of variables that will be passed to the expression at execution time.\nThe variable declarations are used to help the editor provide validation and completion.","type":{"text":"ProfileVariable[]","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}},{"kind":"field","name":"apiVersion","description":"The version of the Arcade API that the editor should use during validation and completion.","type":{"text":"string | undefined"}},{"kind":"field","name":"bundles","description":"The Arcade API bundles that the editor should use during validation and completion.","type":{"text":"BundleType[] | undefined","references":[{"name":"BundleType","package":"@arcgis/languages-api-utils","start":0,"end":10}]}},{"kind":"field","name":"additionalApiItems","description":"A collection of additional Arcade API items that will be provided at runtime.","type":{"text":"ApiItem[] | undefined","references":[{"name":"ApiItem","package":"@arcgis/languages-api-utils","start":0,"end":7}]}},{"kind":"field","name":"hiddenApiItems","description":"A collection of api item names to hide.","type":{"text":"string[] | undefined"}}]},{"kind":"interface","name":"PredefinedProfile","members":[{"kind":"field","name":"id","description":"The well known profile ID.","type":{"text":"ProfileId","references":[{"name":"ProfileId","package":"@arcgis/languages-api-utils","start":0,"end":9}]}},{"kind":"field","name":"disabledVariables","description":"The variables that should be disabled for the profile.","type":{"text":"string[] | undefined"}},{"kind":"field","name":"definitions","description":"Provides the definitions for the definition based variables (feature, featureSet, featureSetCollection).","type":{"text":"VariableDefinitions","references":[{"name":"VariableDefinitions","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#VariableDefinitions","start":0,"end":19}]}},{"kind":"field","name":"hiddenApiItems","description":"A collection of api item names to hide.","type":{"text":"string[] | undefined"}}]},{"kind":"interface","name":"IPredefinedProfile","deprecated":"since 5.1. Use PredefinedProfile instead.","members":[{"kind":"field","name":"id","description":"The well known profile ID.","type":{"text":"ProfileId","references":[{"name":"ProfileId","package":"@arcgis/languages-api-utils","start":0,"end":9}]}},{"kind":"field","name":"disabledVariables","description":"The variables that should be disabled for the profile.","type":{"text":"string[] | undefined"}},{"kind":"field","name":"definitions","description":"Provides the definitions for the definition based variables (feature, featureSet, featureSetCollection).","type":{"text":"VariableDefinitions","references":[{"name":"VariableDefinitions","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#VariableDefinitions","start":0,"end":19}]}},{"kind":"field","name":"hiddenApiItems","description":"A collection of api item names to hide.","type":{"text":"string[] | undefined"}}]},{"kind":"interface","name":"ProfileVariableValueType","description":"The type of value variables supported.","type":{"text":"\"boolean\" | \"date\" | \"dateOnly\" | \"geometry\" | \"knowledgeGraph\" | \"number\" | \"text\" | \"time\""}},{"kind":"interface","name":"ProfileVariable","description":"The supported profile variable types.","docsTags":[{"name":"internalremarks","text":"TODO: hopefully align with @arcgis/core's Arcade variable type in the future"}],"type":{"text":"ProfileArray | ProfileDataCatalogDatastore | ProfileDictionary | ProfileFeature | ProfileFeatureSet | ProfileFeatureSetCollection | ProfilePixel | ProfileValue | ProfileVoxel","references":[{"name":"ProfileArray","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileArray","start":0,"end":12},{"name":"ProfileDataCatalogDatastore","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileDataCatalogDatastore","start":15,"end":42},{"name":"ProfileDictionary","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileDictionary","start":45,"end":62},{"name":"ProfileFeature","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileFeature","start":65,"end":79},{"name":"ProfileFeatureSet","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileFeatureSet","start":82,"end":99},{"name":"ProfileFeatureSetCollection","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileFeatureSetCollection","start":102,"end":129},{"name":"ProfilePixel","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfilePixel","start":132,"end":144},{"name":"ProfileValue","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileValue","start":147,"end":159},{"name":"ProfileVoxel","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVoxel","start":162,"end":174}]}},{"kind":"interface","name":"IProfileVariable","deprecated":"since 5.1. Use ProfileVariable instead.","supertypes":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable"}]},{"kind":"interface","name":"ProfileVariableBase","description":"Properties common to all profile variables.","members":[{"kind":"field","name":"name","description":"Name of the variable","type":{"text":"string"}},{"kind":"field","name":"description","description":"Description for the variable","type":{"text":"string | undefined"}}]},{"kind":"interface","name":"IProfileVariableBase","deprecated":"since 5.1. Use ProfileVariableBase instead.","members":[{"kind":"field","name":"name","description":"Name of the variable","type":{"text":"string"}},{"kind":"field","name":"description","description":"Description for the variable","type":{"text":"string | undefined"}}]},{"kind":"interface","name":"ProfileValue","description":"Single value profile variable declaration.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"ProfileVariableValueType","references":[{"name":"ProfileVariableValueType","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableValueType","start":0,"end":24}]},"readonly":true}]},{"kind":"interface","name":"IProfileValue","deprecated":"since 5.1. Use ProfileValue instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"ProfileVariableValueType","references":[{"name":"ProfileVariableValueType","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableValueType","start":0,"end":24}]},"readonly":true}]},{"kind":"interface","name":"ProfileDictionary","description":"Dictionary profile variable declaration. Properties of a dictionary are profile variables.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"dictionary\""},"readonly":true},{"kind":"field","name":"properties","description":"The dictionary properties. Properties are variables as well.","type":{"text":"ProfileVariable[] | undefined","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}}]},{"kind":"interface","name":"IProfileDictionary","deprecated":"since 5.1. Use ProfileDictionary instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"dictionary\""},"readonly":true},{"kind":"field","name":"properties","description":"The dictionary properties. Properties are variables as well.","type":{"text":"ProfileVariable[] | undefined","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}}]},{"kind":"interface","name":"ProfileArray","description":"Dictionary profile variable declaration. Properties of a dictionary are profile variables.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"array\""},"readonly":true},{"kind":"field","name":"elementType","description":"The type for the array elements.","type":{"text":"ProfileVariable | undefined","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}}]},{"kind":"interface","name":"IProfileArray","deprecated":"since 5.1. Use ProfileArray instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"array\""},"readonly":true},{"kind":"field","name":"elementType","description":"The type for the array elements.","type":{"text":"ProfileVariable | undefined","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}}]},{"kind":"interface","name":"ProfileFeature","description":"Feature profile variable declaration.\nFeatures contains values that can be accessed by a name (aka field name or attribute name).\nOptionally features can have a geometry that can be accessed by a specialized Arcade function.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"feature\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the feature.","type":{"text":"FeatureDefinition | undefined","references":[{"name":"FeatureDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureDefinition","start":0,"end":17}]}}]},{"kind":"interface","name":"IProfileFeature","deprecated":"since 5.1. Use ProfileFeature instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"feature\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the feature.","type":{"text":"FeatureDefinition | undefined","references":[{"name":"FeatureDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureDefinition","start":0,"end":17}]}}]},{"kind":"interface","name":"ProfileFeatureSet","description":"FeatureSet profile variable declaration.\nFeatureSet represents a collection of Features.\nIndividual feature or subset of features can be accessed by using specialized Arcade functions.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"featureSet\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the feature set.","type":{"text":"FeatureSetDefinition | undefined","references":[{"name":"FeatureSetDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureSetDefinition","start":0,"end":20}]}}]},{"kind":"interface","name":"IProfileFeatureSet","deprecated":"since 5.1. Use ProfileFeatureSet instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"featureSet\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the feature set.","type":{"text":"FeatureSetDefinition | undefined","references":[{"name":"FeatureSetDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureSetDefinition","start":0,"end":20}]}}]},{"kind":"interface","name":"ProfileFeatureSetCollection","description":"FeatureSetCollection profile variable declaration.\nFeatureSetCollections are used to represent Feature Services or Web Maps in Arcade expressions.\nFeatureSetCollections expose two collections of Layers and Tables.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"featureSetCollection\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the featureSetCollection will find its definition.","type":{"text":"FeatureSetCollectionDefinition | undefined","references":[{"name":"FeatureSetCollectionDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureSetCollectionDefinition","start":0,"end":30}]}}]},{"kind":"interface","name":"IProfileFeatureSetCollection","deprecated":"since 5.1. Use ProfileFeatureSetCollection instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"featureSetCollection\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the featureSetCollection will find its definition.","type":{"text":"FeatureSetCollectionDefinition | undefined","references":[{"name":"FeatureSetCollectionDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureSetCollectionDefinition","start":0,"end":30}]}}]},{"kind":"interface","name":"ProfileVoxel","description":"Voxel profile variable declaration.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"voxel\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the voxel.","type":{"text":"VoxelDefinition | undefined","references":[{"name":"VoxelDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#VoxelDefinition","start":0,"end":15}]}}]},{"kind":"interface","name":"IProfileVoxel","deprecated":"since 5.1. Use ProfileVoxel instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"voxel\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the voxel.","type":{"text":"VoxelDefinition | undefined","references":[{"name":"VoxelDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#VoxelDefinition","start":0,"end":15}]}}]},{"kind":"interface","name":"ProfilePixel","description":"Pixel profile variable declaration.","supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"pixel\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the pixel.","type":{"text":"PixelDefinition | undefined","references":[{"name":"PixelDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PixelDefinition","start":0,"end":15}]}}]},{"kind":"interface","name":"IProfilePixel","deprecated":"since 5.1. Use ProfilePixel instead.","supertypes":[{"name":"IProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"pixel\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the pixel.","type":{"text":"PixelDefinition | undefined","references":[{"name":"PixelDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PixelDefinition","start":0,"end":15}]}}]},{"kind":"interface","name":"FeatureLikeProfile","type":{"text":"ProfileFeature | ProfilePixel | ProfileVoxel","references":[{"name":"ProfileFeature","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileFeature","start":0,"end":14},{"name":"ProfilePixel","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfilePixel","start":17,"end":29},{"name":"ProfileVoxel","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVoxel","start":32,"end":44}]}},{"kind":"interface","name":"IFeatureLikeProfile","deprecated":"since 5.1. Use FeatureLikeProfile instead.","type":{"text":"IProfileFeature | IProfilePixel | IProfileVoxel","references":[{"name":"IProfileFeature","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileFeature","start":0,"end":15},{"name":"IProfilePixel","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfilePixel","start":18,"end":31},{"name":"IProfileVoxel","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IProfileVoxel","start":34,"end":47}]}},{"kind":"interface","name":"ProfileDataCatalogDatastore","description":"Data catalog datastore profile variable declaration.","docsTags":[{"name":"internal"}],"supertypes":[{"name":"ProfileVariableBase","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariableBase"}],"members":[{"kind":"field","name":"type","type":{"text":"\"dataCatalogDatastore\""},"readonly":true},{"kind":"field","name":"definition","description":"Describes how the editor will find the definition for the data catalog datastore.","type":{"text":"DataCatalogDatastoreSource | undefined","references":[{"name":"DataCatalogDatastoreSource","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogDatastoreSource","start":0,"end":26}]}}]},{"kind":"interface","name":"DataCatalogDatabasePlatform","docsTags":[{"name":"internal"}],"type":{"text":"DataCatalogDatastoreInfo[\"databasePlatform\"]","references":[{"name":"DataCatalogDatastoreInfo","module":"utils/data-catalog-datastore","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/utils/data-catalog-datastore/#DataCatalogDatastoreInfo","start":0,"end":24}]}},{"kind":"interface","name":"DataCatalogDatastoreInfoLike","docsTags":[{"name":"internal"}],"members":[{"kind":"field","name":"datastoreId","description":"The unique data catalog datastore id.","type":{"text":"string"}},{"kind":"field","name":"name","description":"The datastore name.","type":{"text":"string"}},{"kind":"field","name":"type","description":"The datastore type.","type":{"text":"string"}},{"kind":"field","name":"databasePlatform","description":"The database platform identifier.","type":{"text":"DataCatalogDatabasePlatform","references":[{"name":"DataCatalogDatabasePlatform","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogDatabasePlatform","start":0,"end":27}]}}]},{"kind":"interface","name":"DataCatalogDatasetInfoLike","docsTags":[{"name":"internal"}],"members":[{"kind":"field","name":"name","description":"The dataset name.","type":{"text":"string"}},{"kind":"field","name":"type","description":"The dataset type.","type":{"text":"string"}}]},{"kind":"interface","name":"DataCatalogFieldInfoLike","docsTags":[{"name":"internal"}],"members":[{"kind":"field","name":"name","description":"The field name.","type":{"text":"string"}},{"kind":"field","name":"type","description":"The normalized field type used by the editor.","type":{"text":"FeatureLayer[\"fields\"][number][\"type\"]","references":[{"name":"default","module":"layers/FeatureLayer.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/","start":0,"end":12}]}},{"kind":"field","name":"serverType","description":"The raw field type returned by the service.","type":{"text":"string"}},{"kind":"field","name":"nullable","description":"Indicates whether the field allows null values.","type":{"text":"boolean"}}]},{"kind":"interface","name":"DataCatalogTableDescriptionLike","docsTags":[{"name":"internal"}],"members":[{"kind":"field","name":"fields","description":"The fields available in the table.","type":{"text":"DataCatalogFieldInfoLike[]","references":[{"name":"DataCatalogFieldInfoLike","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogFieldInfoLike","start":0,"end":24}]}}]},{"kind":"interface","name":"DataCatalogDatastoreInstance","description":"Data catalog datastore instance shape accepted by the editor.\n\nConsumers can supply either a serialized datastore definition or a live datastore-like\nobject exposing the methods needed to fetch datastore metadata, datasets, and table descriptions.","docsTags":[{"name":"internal"}],"members":[{"kind":"field","name":"itemId","description":"The unique data catalog datastore id.","type":{"text":"string | undefined"}},{"kind":"field","name":"serviceUrl","description":"The url for the data catalog service on the portal.","type":{"text":"string | undefined"}},{"kind":"field","name":"portal","description":"The portal hosting the data catalog service.","type":{"text":"{ url: string; } | undefined"}},{"kind":"field","name":"fetchInfo","description":"Fetches datastore metadata.","type":{"text":"() => Promise<DataCatalogDatastoreInfoLike>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":6,"end":13},{"name":"DataCatalogDatastoreInfoLike","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogDatastoreInfoLike","start":14,"end":42}]}},{"kind":"field","name":"fetchDatasets","description":"Fetches datasets exposed by the datastore.","type":{"text":"() => Promise<DataCatalogDatasetInfoLike[]>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":6,"end":13},{"name":"DataCatalogDatasetInfoLike","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogDatasetInfoLike","start":14,"end":40}]}},{"kind":"field","name":"fetchTableDescription","description":"Fetches a table description for the provided dataset name.","type":{"text":"(tableName: string) => Promise<DataCatalogTableDescriptionLike>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":23,"end":30},{"name":"DataCatalogTableDescriptionLike","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogTableDescriptionLike","start":31,"end":62}]}}]},{"kind":"interface","name":"DataCatalogDatastoreSource","docsTags":[{"name":"internal"}],"type":{"text":"DataCatalogDatastoreDefinition | DataCatalogDatastoreInstance","references":[{"name":"DataCatalogDatastoreDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogDatastoreDefinition","start":0,"end":30},{"name":"DataCatalogDatastoreInstance","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#DataCatalogDatastoreInstance","start":33,"end":61}]}},{"kind":"interface","name":"DataCatalogDatastoreDefinition","description":"Data catalog datastore definition.","docsTags":[{"name":"internal"}],"members":[{"kind":"field","name":"id","description":"The unique data catalog datastore id.","type":{"text":"string"}},{"kind":"field","name":"serviceUrl","description":"The url for the data catalog service on the portal","type":{"text":"string"}},{"kind":"field","name":"portal","description":"The portal url. This is required for accessing the data catalog service","type":{"text":"{ url: string; }"}}]},{"kind":"interface","name":"PortalItemProperties","description":"Describes a portal item.","members":[{"kind":"field","name":"id","description":"The unique portal item id.","type":{"text":"string"}},{"kind":"field","name":"portal","description":"The optional portal url. Default: www.arcgis.com.","type":{"text":"{ url: string; } | undefined"}}]},{"kind":"interface","name":"IPortalItemProperties","deprecated":"since 5.1. Use PortalItemProperties instead.","members":[{"kind":"field","name":"id","description":"The unique portal item id.","type":{"text":"string"}},{"kind":"field","name":"portal","description":"The optional portal url. Default: www.arcgis.com.","type":{"text":"{ url: string; } | undefined"}}]},{"kind":"interface","name":"PortalItemDefinition","description":"WebMap and Service FeatureSetCollection can be defined by a portal item.","members":[{"kind":"field","name":"portalItem","description":"Describes a portal item.","type":{"text":"PortalItemProperties","references":[{"name":"PortalItemProperties","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PortalItemProperties","start":0,"end":20}]}}]},{"kind":"interface","name":"IPortalItemDefinition","deprecated":"since 5.1. Use PortalItemDefinition instead.","members":[{"kind":"field","name":"portalItem","description":"Describes a portal item.","type":{"text":"PortalItemProperties","references":[{"name":"PortalItemProperties","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PortalItemProperties","start":0,"end":20}]}}]},{"kind":"interface","name":"FeatureLayerItemDefinition","description":"FeatureLayer can be defined from a Feature Layer portal item.","supertypes":[{"name":"PortalItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PortalItemDefinition"}],"members":[{"kind":"field","name":"layerId","description":"The layer id in the feature layer portal item. Default to 0.","type":{"text":"number | undefined"}}]},{"kind":"interface","name":"IFeatureLayerItemDefinition","deprecated":"since 5.1. Use FeatureLayerItemDefinition instead.","supertypes":[{"name":"IPortalItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IPortalItemDefinition"}],"members":[{"kind":"field","name":"layerId","description":"The layer id in the feature layer portal item. Default to 0.","type":{"text":"number | undefined"}}]},{"kind":"interface","name":"UrlDefinition","description":"FeatureLayers and GroupLayers can be created by providing the url to the resource in a feature service.","members":[{"kind":"field","name":"url","description":"The url of the resource.","type":{"text":"string | null | undefined"}}]},{"kind":"interface","name":"IUrlDefinition","deprecated":"since 5.1. Use UrlDefinition instead.","members":[{"kind":"field","name":"url","description":"The url of the resource.","type":{"text":"string | null | undefined"}}]},{"kind":"interface","name":"FieldsDefinition","description":"The most basic way to define a feature or feature set is by passing a collection of fields","supertypes":[{"name":"Pick","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys","typeArguments":[{"text":"FeatureLayer","references":[{"name":"default","module":"layers/FeatureLayer.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/","start":0,"end":12}]},{"text":"\"fields\""}]}]},{"kind":"interface","name":"IFieldsDefinition","deprecated":"since 5.1. Use FieldsDefinition instead.","supertypes":[{"name":"FieldsDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FieldsDefinition"}]},{"kind":"interface","name":"FeatureDefinition","description":"FeatureDefinition represents various ways a Feature variable could be defined.\nLayer instance is the most common way to define a feature,\nthe minimum required is that the layer instance exposes a collection of fields.\nAn object with just fields can be used to define a feature from a collection of fields.\nAn object with a url property can be used to define a feature from a feature service.\nAn object with minimal portal item properties and a layer id can be used to define a feature from a feature layer portal item.\nFor the last two options, a feature layer instance will be created by the editor profile.","type":{"text":"FeatureLayerItemDefinition | FieldsDefinition | UrlDefinition","references":[{"name":"FeatureLayerItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureLayerItemDefinition","start":0,"end":26},{"name":"FieldsDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FieldsDefinition","start":29,"end":45},{"name":"UrlDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#UrlDefinition","start":48,"end":61}]}},{"kind":"interface","name":"VoxelDefinition","description":"VoxelDefinition represents various ways a Voxel variable could be defined.\nLayer instance is the most common way to define a voxel.","type":{"text":"FeatureLayerItemDefinition | UrlDefinition | VoxelLayer","references":[{"name":"FeatureLayerItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureLayerItemDefinition","start":0,"end":26},{"name":"UrlDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#UrlDefinition","start":29,"end":42},{"name":"default","module":"layers/VoxelLayer.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/layers/VoxelLayer/","start":45,"end":55}]}},{"kind":"interface","name":"PixelDefinition","description":"PixelDefinition represents various ways a Pixel variable could be defined.","type":{"text":"FeatureLayerItemDefinition | ImageryLayer | ImageryTileLayer | UrlDefinition","references":[{"name":"FeatureLayerItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureLayerItemDefinition","start":0,"end":26},{"name":"default","module":"layers/ImageryLayer.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/","start":29,"end":41},{"name":"default","module":"layers/ImageryTileLayer.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryTileLayer/","start":44,"end":60},{"name":"UrlDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#UrlDefinition","start":63,"end":76}]}},{"kind":"interface","name":"FeatureSetDefinition","description":"FeatureSetDefinition represents the various ways a FeatureSet variable could be defined.\nSee FeatureDefinition for more details.","type":{"text":"FeatureLayerItemDefinition | FieldsDefinition | UrlDefinition","references":[{"name":"FeatureLayerItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureLayerItemDefinition","start":0,"end":26},{"name":"FieldsDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FieldsDefinition","start":29,"end":45},{"name":"UrlDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#UrlDefinition","start":48,"end":61}]}},{"kind":"interface","name":"FeatureSetCollectionDefinition","description":"FeatureSetCollectionDefinition represents the various ways a FeatureSetCollection could be defined\nas a feature service or a web map.","type":{"text":"Map | PortalItemDefinition | UrlDefinition | WebMap | WebScene","references":[{"name":"default","module":"Map.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/Map/","start":0,"end":3},{"name":"PortalItemDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PortalItemDefinition","start":6,"end":26},{"name":"UrlDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#UrlDefinition","start":29,"end":42},{"name":"default","module":"WebMap.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/WebMap/","start":45,"end":51},{"name":"default","module":"WebScene.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/WebScene/","start":54,"end":62}]}},{"kind":"interface","name":"VariableDefinitions","description":"A collection of variables that make up a profile definition.","supertypes":[{"name":"Record","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type","typeArguments":[{"text":"string"},{"text":"FeatureDefinition | FeatureSetCollectionDefinition | FeatureSetDefinition | ProfileVariable[] | undefined","references":[{"name":"FeatureDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureDefinition","start":0,"end":17},{"name":"FeatureSetCollectionDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureSetCollectionDefinition","start":20,"end":50},{"name":"FeatureSetDefinition","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#FeatureSetDefinition","start":53,"end":73},{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":76,"end":91}]}]}]},{"kind":"interface","name":"ExtendedPredefinedProfile","supertypes":[{"name":"PredefinedProfile","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#PredefinedProfile"}],"members":[{"kind":"field","name":"additionalVariables","type":{"text":"ProfileVariable[] | undefined","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}}]},{"kind":"interface","name":"IExtendedPredefinedProfile","deprecated":"since 5.1. Use ExtendedPredefinedProfile instead.","supertypes":[{"name":"IPredefinedProfile","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IPredefinedProfile"}],"members":[{"kind":"field","name":"additionalVariables","type":{"text":"ProfileVariable[] | undefined","references":[{"name":"ProfileVariable","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ProfileVariable","start":0,"end":15}]}}]},{"kind":"interface","name":"EditorCodeSuggestionGroup","members":[{"kind":"field","name":"label","description":"Label for the suggestion group","type":{"text":"string"}},{"kind":"field","name":"suggestions","description":"List of suggestions for the group","type":{"text":"EditorCodeSuggestion[]","references":[{"name":"EditorCodeSuggestion","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#EditorCodeSuggestion","start":0,"end":20}]}}]},{"kind":"interface","name":"IEditorCodeSuggestionGroup","deprecated":"since 5.1. Use EditorCodeSuggestionGroup instead.","members":[{"kind":"field","name":"label","description":"Label for the suggestion group","type":{"text":"string"}},{"kind":"field","name":"suggestions","description":"List of suggestions for the group","type":{"text":"EditorCodeSuggestion[]","references":[{"name":"EditorCodeSuggestion","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#EditorCodeSuggestion","start":0,"end":20}]}}]},{"kind":"interface","name":"EditorCodeSuggestion","members":[{"kind":"field","name":"label","description":"A short label for the suggestion. Can be thought as a title","type":{"text":"string"}},{"kind":"field","name":"description","description":"A short description that will be showed below the label in the list of suggestions panel","type":{"text":"string | undefined"}},{"kind":"field","name":"documentation","description":"Markdown string that will be rendered along with the code in the detail panel","type":{"text":"string | undefined"}},{"kind":"field","name":"code","description":"The code for the suggestion. Will be injected in the editor is selected","type":{"text":"string"}}]},{"kind":"interface","name":"IEditorCodeSuggestion","deprecated":"since 5.1. Use EditorCodeSuggestion instead.","members":[{"kind":"field","name":"label","description":"A short label for the suggestion. Can be thought as a title","type":{"text":"string"}},{"kind":"field","name":"description","description":"A short description that will be showed below the label in the list of suggestions panel","type":{"text":"string | undefined"}},{"kind":"field","name":"documentation","description":"Markdown string that will be rendered along with the code in the detail panel","type":{"text":"string | undefined"}},{"kind":"field","name":"code","description":"The code for the suggestion. Will be injected in the editor is selected","type":{"text":"string"}}]},{"kind":"interface","name":"SidePanelName","type":{"text":"\"api\" | \"none\" | \"suggestions\" | \"variables\""}},{"kind":"interface","name":"ContextReferences","members":[{"kind":"field","name":"spatialReference","description":"Spatial reference object used to define the spatial reference for the arcade runtime.\nBy defaults, the spatial reference is set to Web Mercator (wkid: 3857).","type":{"text":"SpatialReference | { wkid: number; } | null | undefined","references":[{"name":"default","module":"geometry/SpatialReference.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/","start":0,"end":16}]}},{"kind":"field","name":"timeZone","description":"Defines the default time zone in which to create and display Arcade date types.\nBy default, the time zone is set to \"system\".","type":{"text":"string | undefined"}},{"kind":"field","name":"services","description":"Defines the \"services\" passed to the arcade executor.","type":{"text":"ArcadeServices | undefined","references":[{"name":"ArcadeServices","module":"arcade.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/arcade/#ArcadeServices","start":0,"end":14}]}}]},{"kind":"interface","name":"IContextReferences","deprecated":"since 5.1. Use ContextReferences instead.","members":[{"kind":"field","name":"spatialReference","description":"Spatial reference object used to define the spatial reference for the arcade runtime.\nBy defaults, the spatial reference is set to Web Mercator (wkid: 3857).","type":{"text":"SpatialReference | { wkid: number; } | null | undefined","references":[{"name":"default","module":"geometry/SpatialReference.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/","start":0,"end":16}]}},{"kind":"field","name":"timeZone","description":"Defines the default time zone in which to create and display Arcade date types.\nBy default, the time zone is set to \"system\".","type":{"text":"string | undefined"}},{"kind":"field","name":"services","description":"Defines the \"services\" passed to the arcade executor.","type":{"text":"ArcadeServices | undefined","references":[{"name":"ArcadeServices","module":"arcade.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/arcade/#ArcadeServices","start":0,"end":14}]}}]},{"kind":"interface","name":"EditorTestContext","description":"If a profile doesn't contain a map, the spatial reference of geometries will be defaulted to\nwkid: 3857.\nThe test context objects allows to set the execution spatial reference for such scenario.","supertypes":[{"name":"ContextReferences","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#ContextReferences"}],"members":[{"kind":"field","name":"profileVariableInstances","description":"An object of key/value pairs where the key is the name of a profile variable.\nThe key's value must be of type ArcGIS core ProfileVariableInstance.","type":{"text":"ProfileVariableInstances","references":[{"name":"ProfileVariableInstances","module":"arcade.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/arcade/#ProfileVariableInstances","start":0,"end":24}]}}]},{"kind":"interface","name":"IEditorTestContext","deprecated":"since 5.1. Use EditorTestContext instead.","supertypes":[{"name":"IContextReferences","viewUrl":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/types/#IContextReferences"}],"members":[{"kind":"field","name":"profileVariableInstances","description":"An object of key/value pairs where the key is the name of a profile variable.\nThe key's value must be of type ArcGIS core ProfileVariableInstance.","type":{"text":"ProfileVariableInstances","references":[{"name":"ProfileVariableInstances","module":"arcade.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/arcade/#ProfileVariableInstances","start":0,"end":24}]}}]}]},{"kind":"javascript-module","path":"components/arcgis-arcade-editor","sourcePath":"src/components/arcade-editor/arcade-editor.tsx","declarations":[{"kind":"class","name":"ArcgisArcadeEditor","customElement":true,"tagName":"arcgis-arcade-editor","pascalCaseName":"ArcgisArcadeEditor","description":"[**Arcade**](https://developers.arcgis.com/arcade/) is a portable, and lightweight expression language used to create custom content throughout the [ArcGIS system](https://www.esri.com/en-us/arcgis/products/index).\nLike other expression languages, it can perform mathematical calculations, format text, and evaluate logical statements.\nIt also supports multi-statement expressions, variables, and flow control statements. Arcade is unique when compared to other expression and scripting languages due to its inclusion of [feature](https://developers.arcgis.com/arcade/guide/types/#feature) and [geometry](https://developers.arcgis.com/arcade/guide/types/#geometry) data types.\n\nMap Viewer (MV) was the first ArcGIS Online product to incorporate the new Arcade editor after [the editor's introduction in the November 2022 ArcGIS Online release](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/introducing-the-new-arcade-editor-in-arcgis-online/).\nThis was possible thanks to the Arcade editor component, which enabled MV to implement its own Arcade expression builder.\nYou can now also find the editor in ArcGIS Dashboards, ArcGIS Field Maps, and ArcGIS Velocity.\n\nYou can easily get your own dedicated Arcade expression builder with the **Arcade editor** component, which includes:\n\n- An easy to use [l