@arcgis/core 5.2.0-next.120 → 5.2.0-next.121

package/legend/LegendContent.d.ts

@@ -0,0 +1,118 @@
+import type Accessor from "../core/Accessor.js";
+import type Collection from "../core/Collection.js";
+import type ActiveLayerInfo from "./ActiveLayerInfo.js";
+import type LinkChartView from "../views/LinkChartView.js";
+import type { LayerInfo, LegendContentState } from "./types.js";
+import type { MapViewOrSceneView } from "../views/MapViewOrSceneView.js";
+import type { ActiveLayerInfoProperties } from "./ActiveLayerInfo.js";
+import type { ReadonlyArrayOrCollection } from "../core/Collection.js";
+
+export interface LegendContentProperties extends Partial<Pick<LegendContent, "basemapLegendVisible" | "groundLegendVisible" | "hideLayersNotInCurrentView" | "keepCacheOnDestroy" | "layerInfos" | "respectLayerDefinitionExpression" | "respectLayerVisibility" | "view">> {
+  /**
+   * Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/) objects used by the legend view to
+   * display data in the legend. Use this property to hide or display the layer's symbols in the legend when
+   * an [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/) is removed from or added to this collection.
+   */
+  activeLayerInfos?: ReadonlyArrayOrCollection<ActiveLayerInfoProperties>;
+}
+
+/**
+ * Manages the reactive content displayed by the [Legend component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/)
+ * and by custom legends. It tracks supported layer views, maintains the hierarchy of
+ * [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/) objects, and coordinates legend element generation as the view changes.
+ *
+ * @since 5.2
+ * @example
+ * const legendContent = new LegendContent({
+ *   view,
+ *   layerInfos: [{ layer: map.allLayers.getItemAt(0) }],
+ * });
+ */
+export default class LegendContent extends Accessor {
+  constructor(properties?: LegendContentProperties);
+  /**
+   * Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/) objects used by the legend view to
+   * display data in the legend. Use this property to hide or display the layer's symbols in the legend when
+   * an [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/) is removed from or added to this collection.
+   */
+  get activeLayerInfos(): Collection<ActiveLayerInfo>;
+  set activeLayerInfos(value: ReadonlyArrayOrCollection<ActiveLayerInfoProperties>);
+  /**
+   * Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers in the legend.
+   *
+   * @default false
+   */
+  accessor basemapLegendVisible: boolean;
+  /**
+   * Indicates whether to include [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/) layers in the legend.
+   *
+   * @default false
+   */
+  accessor groundLegendVisible: boolean;
+  /**
+   * When `true`, layers will only be shown in the legend if
+   * they are visible in the view's extent. When data from a layer
+   * is not visible in the view, the layer's legend information
+   * will be hidden.
+   *
+   * To hide layers completely
+   * from the legend, you should set the `legendEnabled` property of
+   * the layer to `false`.
+   *
+   * @default false
+   * @see [respectLayerVisibility](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/#respectLayerVisibility)
+   */
+  accessor hideLayersNotInCurrentView: boolean;
+  /**
+   * Indicates whether cached legend responses should be preserved when active layer info objects are destroyed.
+   * Preserving the cache can avoid repeating legend requests when rebuilding legend content.
+   *
+   * @default false
+   */
+  accessor keepCacheOnDestroy: boolean;
+  /**
+   * Defines which layers and sublayers are shown in the legend, including any [basemap layers](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/#basemapLegendVisible) you want visible.
+   * If not set, all layers in the map are displayed in the legend by default, including basemap layers when
+   * [basemapLegendVisible](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/#basemapLegendVisible) is `true`.
+   */
+  accessor layerInfos: LayerInfo[];
+  /** Indicates whether one or more active layer info objects are currently generating legend elements. */
+  get loading(): boolean;
+  /**
+   * If a layer uses a unique value renderer, only features that satisfy the layer's
+   * [definition expression](https://developers.arcgis.com/javascript/latest/references/core/layers/mixins/FeatureLayerBase/#definitionExpression)
+   * will be displayed in the legend when set to true.
+   *
+   * @default false
+   * @see [FeatureLayerBase.definitionExpression](https://developers.arcgis.com/javascript/latest/references/core/layers/mixins/FeatureLayerBase/#definitionExpression)
+   */
+  accessor respectLayerDefinitionExpression: boolean;
+  /**
+   * Determines whether to respect the properties of the layers in the map that
+   * control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).
+   * By default, a layer's legend elements **will
+   * not render** in the legend given the following conditions:
+   *
+   * - The [FeatureLayer.legendEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#legendEnabled) property
+   * is set to `false`.
+   * - If the view's scale is outside the visibility range
+   * defined by the [ScaleRangeLayer.minScale](https://developers.arcgis.com/javascript/latest/references/core/layers/mixins/ScaleRangeLayer/#minScale) and
+   * [ScaleRangeLayer.maxScale](https://developers.arcgis.com/javascript/latest/references/core/layers/mixins/ScaleRangeLayer/#maxScale) properties.
+   *
+   * When the `respectLayerVisibility` property of the legend is set to `false`, the legend elements for each
+   * layer in the map will always display, thus disregarding the `minScale`, `maxScale`,
+   * and `legendEnabled` properties for each layer in the map.
+   *
+   * @default true
+   * @see [hideLayersNotInCurrentView](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/#hideLayersNotInCurrentView)
+   */
+  accessor respectLayerVisibility: boolean;
+  /**
+   * The current state of the legend content.
+   *
+   * @default "disabled"
+   */
+  get state(): LegendContentState;
+  /** The map, scene, or link chart view whose layer views supply the legend content. */
+  accessor view: MapViewOrSceneView | LinkChartView | null | undefined;
+}

package/legend/LegendContent.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import{onLocaleChange as i}from"../intl.js";import r from"../core/Accessor.js";import t from"../core/Collection.js";import{watch as s,initial as a,when as n}from"../core/reactiveUtils.js";import{property as o,subclass as l}from"../core/accessorSupport/decorators.js";import{get as y}from"../core/accessorSupport/get.js";import d from"./ActiveLayerInfo.js";import{getEffectiveFeatureReduction as h}from"../views/2d/layers/features/layerAdapters/featureReductionUtils.js";const c={state:"state",view:"view",allLayerViews:"all-layer-views",legendProperties:"legend-properties"},L=t.ofType(d),f=new Set(["esri.layers.BuildingSceneLayer","esri.layers.CatalogLayer","esri.layers.CSVLayer","esri.layers.FeatureLayer","esri.layers.GeoJSONLayer","esri.layers.GeoRSSLayer","esri.layers.GroupLayer","esri.layers.HeatmapLayer","esri.layers.ImageryLayer","esri.layers.ImageryTileLayer","esri.layers.MapImageLayer","esri.layers.OGCFeatureLayer","esri.layers.OrientedImageryLayer","esri.layers.ParquetLayer","esri.layers.PointCloudLayer","esri.layers.StreamLayer","esri.layers.SceneLayer","esri.layers.SubtypeGroupLayer","esri.layers.TileLayer","esri.layers.VoxelLayer","esri.layers.WFSLayer","esri.layers.WMSLayer","esri.layers.WMTSLayer","esri.layers.WCSLayer","esri.layers.LinkChartLayer","esri.layers.catalog.CatalogFootprintLayer","esri.layers.catalog.CatalogDynamicGroupLayer","esri.layers.knowledgeGraph.KnowledgeGraphSublayer","esri.layers.KnowledgeGraphLayer"]),u="view.basemapView.baseLayerViews",p="view.groundView.layerViews",v="view.basemapView.referenceLayerViews",w=[u,p,"view.layerViews",v];let _=class extends r{constructor(e){super(e),this._layerViewByLayerId={},this._layerInfosByLayerViewId={},this._activeLayerInfosByLayerViewId={},this._activeLayerInfosWithNoParent=new t,this._activeLayerInfosPromises=new WeakMap,this.activeLayerInfos=new L,this.basemapLegendVisible=!1,this.groundLegendVisible=!1,this.hideLayersNotInCurrentView=!1,this.keepCacheOnDestroy=!1,this.layerInfos=[],this.respectLayerDefinitionExpression=!1,this.respectLayerVisibility=!0,this.view=null}initialize(){this.addHandles(s(()=>this.view,()=>this._viewHandles(),a),c.view),this.addHandles(i(()=>this._refresh()))}destroy(){this._destroyViewActiveLayerInfos(),this.view=null}get loading(){return this.activeLayerInfos.some(e=>e.loading)}get state(){return this.view?.ready?"ready":"disabled"}_viewHandles(){this.removeHandles(c.state),this.view&&this.addHandles(s(()=>this.state,()=>this._stateHandles(),a),c.state)}_stateHandles(){this._resetAll(),"ready"===this.state&&this._watchPropertiesAndAllLayerViews()}_resetAll(){this.removeHandles([c.allLayerViews,c.legendProperties]),this._destroyViewActiveLayerInfos(),this.activeLayerInfos.removeAll()}_destroyViewActiveLayerInfos(){Object.keys(this._activeLayerInfosByLayerViewId).forEach(this._destroyViewActiveLayerInfo,this)}_destroyViewActiveLayerInfo(e){this.removeHandles(e);const i=this._activeLayerInfosByLayerViewId[e];i&&this._activeLayerInfosPromises.delete(i),delete this._activeLayerInfosByLayerViewId[e],i?.parent?.children.remove(i)}_watchPropertiesAndAllLayerViews(){const{view:e}=this;if(!e)return;const{allLayerViews:i}=e;i.length&&this._refresh(),this.addHandles(i.on("change",e=>this._allLayerViewsChangeHandle(e)),c.allLayerViews),this.addHandles(s(()=>[this.basemapLegendVisible,this.groundLegendVisible,this.hideLayersNotInCurrentView,this.keepCacheOnDestroy,this.layerInfos,this.respectLayerDefinitionExpression,this.respectLayerVisibility],()=>this._refresh()),c.legendProperties)}_allLayerViewsChangeHandle(e){if(e.added.length&&this._generateActiveLayerInfosForLayerViews(e.added),e.moved.length)return this._destroyViewActiveLayerInfos(),void this._refresh();if(e.removed.length){for(const{uid:i}of e.removed)this._destroyViewActiveLayerInfo(i);this._refresh()}}_refresh(){this._layerInfosByLayerViewId={},this.activeLayerInfos.drain(e=>this._activeLayerInfosPromises.delete(e)),this._generateActiveLayerInfosForLayerViews(this._generateLayerViews())}_generateActiveLayerInfosForLayerViews(e){e.filter(this._filterBasemapLayerViews,this).filter(this._filterLayerViewsByLayerInfos,this).filter(this._isLayerViewSupported,this).forEach(this._generateActiveLayerInfo,this)}_filterBasemapLayerViews(e){if(!this.view?.basemapView)return!0;const{baseLayerViews:i,groundLayerViews:r,referenceLayerViews:t}=this.view.basemapView,s=i.some(i=>{const r="layerViews"in i?i.layerViews:null;return r?r.includes(e):i===e}),a=!this.basemapLegendVisible&&(s||t?.includes(e)),n=!this.groundLegendVisible&&r?.includes(e);return!a&&!n}_sortActiveLayerInfos(e){const i=this.view;if(e.length<2||!i)return;const r=[];e.forEach(i=>{if(!i.parent){const t=i.layer.parent,s=t&&"uid"in t&&this._layerViewByLayerId[t.uid],a=s&&this._activeLayerInfosByLayerViewId[s.uid];a&&e.includes(a)&&(r.push(i),i.parent=a,a.children.add(i),this._sortActiveLayerInfos(a.children))}}),e.removeMany(r);const t={};i.allLayerViews.forEach((e,i)=>t[e.layer.uid]=i),e.sort((e,i)=>{const r=t[e.layer.uid]||0;return(t[i.layer.uid]||0)-r})}_generateLayerViews(){const e=[];return w.filter(this._filterLayerViews,this).map(e=>y(this,e)).filter(e=>null!=e).forEach(this._collectLayerViews("layerViews",e)),e}_filterLayerViews(e){const i=!this.basemapLegendVisible&&(e===u||e===v),r=!this.groundLegendVisible&&e===p;return!i&&!r}_collectLayerViews(e,i){const r=t=>(t&&t.forEach(t=>{i.push(t),r(t[e])}),i);return r}_filterLayerViewsByLayerInfos(e){const i=this.layerInfos;return!i||!i.length||i.some(i=>this._hasLayerInfo(i,e))}_hasLayerInfo(e,i){const r=this._isLayerUIDMatching(e.layer,i.layer.uid);return r&&(this._layerInfosByLayerViewId[i.uid]=e),r}_isLayerUIDMatching(e,i){return e&&(e.uid===i||this._hasLayerUID(e.layers,i))}_hasLayerUID(e,i){return e&&e.some(e=>this._isLayerUIDMatching(e,i))}_isLayerViewSupported(e){return!!f.has(e.layer.declaredClass)&&(this._layerViewByLayerId[e.layer.uid]=e,!0)}_generateActiveLayerInfo(e){this._isLayerActive(e)?this._buildActiveLayerInfo(e):(this.removeHandles(e.uid),this.addHandles(s(()=>[e.legendEnabled,e.layer?.legendEnabled],()=>this._layerActiveHandle(e)),e.uid))}_layerActiveHandle(e){this._isLayerActive(e)&&(this.removeHandles(e.uid),this._buildActiveLayerInfo(e))}_isLayerActive(e){return!this.respectLayerVisibility||e.legendEnabled&&e.layer?.legendEnabled}async _buildActiveLayerInfo(e){const i=e.layer,r=e.uid,t=this._layerInfosByLayerViewId[r];let s=this._activeLayerInfosByLayerViewId[r];s||(s=new d({keepCacheOnDestroy:this.keepCacheOnDestroy,layer:i,layerView:e,view:this.view??void 0}),this._activeLayerInfosByLayerViewId[r]=s);const a=void 0!==t?.title&&t.layer.uid===i.uid;s.title=a?t.title:i.title,s.respectLayerDefinitionExpression=this.respectLayerDefinitionExpression,s.respectLayerVisibility=this.respectLayerVisibility,s.hideLayersNotInCurrentView=this.hideLayersNotInCurrentView,s.sublayerIds=t?.sublayerIds||[];const n=i.parent&&"uid"in i.parent?this._layerViewByLayerId[i.parent?.uid]:null;s.parent=this._activeLayerInfosByLayerViewId[n?.uid],this._addActiveLayerInfo(s),this._constructLegendElements(s),this._attachHandlesToActiveLayerInfo(s)}_attachHandlesToActiveLayerInfo(e){const{layer:i,layerView:r}=e,t=r.uid;this.removeHandles(t),this.addHandles([s(()=>i.title,i=>this._titleHandle(i,e)),s(()=>[i.opacity,"renderer"in i&&i.renderer,"pointSymbol"in i&&i.pointSymbol,"lineSymbol"in i&&i.lineSymbol,"polygonSymbol"in i&&i.polygonSymbol,"effect"in i&&i.effect,"featureReduction"in i&&h(i,r.view),this.view?.timeZone],()=>this._constructLegendElements(e)),s(()=>"filter"in r&&r.filter,()=>{null!=h(r.layer,r.view)&&this._constructLegendElements(e)}),n(()=>!!this.view?.stationary,()=>this._scaleHandle(e)),s(()=>e.loading,()=>this.notifyChange("loading"),a)],t),this.respectLayerVisibility&&this.addHandles([s(()=>i.legendEnabled,i=>this._legendEnabledHandle(i,e)),s(()=>r.legendEnabled,i=>{this.view?.suspended||this._legendEnabledHandle(i,e)})],t),this.respectLayerDefinitionExpression&&"definitionExpression"in i&&this.addHandles(s(()=>i.definitionExpression,()=>this._constructLegendElements(e)),t)}_titleHandle(e,i){i.title=e,this._constructLegendElements(i)}_legendEnabledHandle(e,i){e?this._addActiveLayerInfo(i):this._removeActiveLayerInfo(i)}_scaleHandle(e){(e.isScaleDriven||e.hideLayersNotInCurrentView)&&this._constructLegendElements(e)}_addActiveLayerInfo(e){const{layerView:i,layer:r}=e;if(this._isLayerActive(i)&&!this.activeLayerInfos.includes(e)){const i=e.parent;if(i)i.children.includes(e)||i.children.push(e),this._sortActiveLayerInfos(i.children);else{const i=this.layerInfos?.some(e=>e.layer.uid===r.uid),t=r.parent;(t&&"uid"in t?this._layerViewByLayerId[t.uid]:null)&&!i?this._activeLayerInfosWithNoParent.add(e):(this.activeLayerInfos.add(e),this._sortActiveLayerInfos(this.activeLayerInfos))}if(this._activeLayerInfosWithNoParent.length){const e=[];this._activeLayerInfosWithNoParent.forEach(i=>{const r=i.layer.parent,t=r&&"uid"in r?this._layerViewByLayerId[r?.uid]:null,s=this._activeLayerInfosByLayerViewId[t?.uid];s&&(e.push(i),i.parent=s)}),e.length&&(this._activeLayerInfosWithNoParent.removeMany(e),e.forEach(e=>this._addActiveLayerInfo(e)))}}}_removeActiveLayerInfo(e){const i=e.parent;i?i.children.remove(e):this.activeLayerInfos.remove(e)}async _getBuildLegendPromise(e){const{layer:i}=e;if("featureCollections"in i&&i.featureCollections)return e.buildLegendElementsForFeatureCollections(i.featureCollections);if("featureReduction"in i&&i.featureReduction&&"renderer"in i.featureReduction&&("binning"===i.featureReduction.type||"cluster"===i.featureReduction.type)&&(!this.view||i.featureReduction.maxScale<=this.view.scale))return e.buildLegendElementsForFeatureReduction(i.featureReduction);if("renderer"in i&&i.renderer&&!("sublayers"in i))return e.buildLegendElementsForRenderer(i.renderer);if("url"in i&&i.url&&"catalog"!==i.type&&"knowledge-graph"!==i.type)return e.buildLegendElementsForTools();const r=e.children.map(e=>this._constructLegendElements(e));return Promise.all(r).then(()=>{})}async _constructLegendElements(e){const i=this._activeLayerInfosPromises.get(e);i&&await i.catch(()=>{});const r=this._getBuildLegendPromise(e);this._activeLayerInfosPromises.set(e,r),r.finally(()=>{this._activeLayerInfosPromises.delete(e)})}};e([o({type:L})],_.prototype,"activeLayerInfos",void 0),e([o()],_.prototype,"basemapLegendVisible",void 0),e([o()],_.prototype,"groundLegendVisible",void 0),e([o()],_.prototype,"hideLayersNotInCurrentView",void 0),e([o()],_.prototype,"keepCacheOnDestroy",void 0),e([o()],_.prototype,"layerInfos",void 0),e([o({readOnly:!0})],_.prototype,"loading",null),e([o()],_.prototype,"respectLayerDefinitionExpression",void 0),e([o()],_.prototype,"respectLayerVisibility",void 0),e([o({readOnly:!0})],_.prototype,"state",null),e([o()],_.prototype,"view",void 0),_=e([l("esri.legend.LegendContent")],_);const I=_;export{I as default};

package/legend/support/clusterUtils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import e from"../../renderers/visualVariables/SizeVariable.js";function l(l,i,s){const a=l.effectiveClusterRenderer;if(!a||!("visualVariables"in a)||!a.visualVariables)return null;const n=a.visualVariables.find(e=>"size"===e.type);if(!("stops"in n)||!n.stops)return null;const t=n.stops.find(e=>e.useMinValue),u=n.stops.find(e=>e.useMaxValue);if(null==t||null==u)return null;const r=s.featuresTilingScheme.getClosestInfoForScale(s.scale).level,f=n.field,o=i.getDisplayStatistics(r,f);return o?new e({field:n.field,minSize:l.clusterMinSize,minDataValue:o.minValue,maxSize:l.clusterMaxSize,maxDataValue:o.maxValue}):null}export{l as getEffectiveClusterSizeVariable};

package/legend/support/colorRampUtils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import l from"../../Color.js";import{isSome as e}from"../../core/arrayUtils.js";import{createStopLabel as o}from"./utils.js";const r=new l([64,64,64]);function n(l,e){const r=[],n=l.length-1;return 5===l.length?r.push(0,2,4):r.push(0,n),l.map((l,t)=>r.includes(t)?o(l,t,n,e):null)}async function t(l,o,r){let t=!1,u=[],s=[];if(l.stops){const e=l.stops;u=e.map(l=>l.value),t=e.some(l=>!!l.label),t&&(s=e.map(l=>l.label))}const i=u[0],c=u[u.length-1];if(null==i&&null==c)return null;const p=t?null:n(u,r);return(await Promise.all(u.map(async(e,r)=>{const n="opacity"===l.type?await a(e,l,o):(await(import("../../renderers/visualVariables/support/visualVariableUtils.js"))).getColor(l,e),u=t?s[r]:p?.[r]??"";return null==n?null:{value:e,color:n,label:u}}))).filter(e).reverse()}async function a(e,o,n){const t=new l(n??r),a=(await(import("../../renderers/visualVariables/support/visualVariableUtils.js"))).getOpacity(o,e);return null!=a&&(t.a=a),t}function u(l){let e=!1,o=[],r=[];o=l.map(l=>l.value),e=l.some(l=>!!l.label),e&&(r=l.map(l=>l.label??""));const t=o[0],a=o[o.length-1];if(null==t&&null==a)return null;const u=e?null:n(o);return o.map((o,n)=>({value:o,color:s(o,l),label:e?r[n]:u?.[n]??""})).reverse()}function s(e,o){const{startIndex:r,endIndex:n,weight:t}=i(e,o);if(r===n)return o[r].color;const a=l.blendColors(o[r].color,o[n].color,t);return new l(a)}function i(l,e){let o=0,r=e.length-1;return e.some((e,n)=>l<e.value?(r=n,!0):(o=n,!1)),{startIndex:o,endIndex:r,weight:(l-e[o].value)/(e[r].value-e[o].value)}}function c(e,o){let r=[];if("multipart"===e?.type)e.colorRamps.reverse().forEach((n,t)=>{0===t?r.push({value:o.max,color:new l(n.toColor),label:"high"}):r.push({value:null,color:new l(n.toColor),label:""}),t===e.colorRamps.length-1?r.push({value:o.min,color:new l(n.fromColor),label:"low"}):r.push({value:null,color:new l(n.fromColor),label:""})});else{let n,t;"algorithmic"===e?.type?(n=e.fromColor,t=e.toColor):(n=[0,0,0,1],t=[255,255,255,1]),r=[{value:o.max,color:new l(t),label:"high"},{value:o.min,color:new l(n),label:"low"}]}return r}export{s as getColorFromPointCloudStops,t as getRampStops,u as getRampStopsForPointCloud,c as getStretchRampStops};

package/legend/support/heatmapRampUtils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import o from"../../renderers/support/HeatmapColorStop.js";function r(r){if(!r.colorStops)return[];const e=r.colorStops.filter(o=>o.color?.a>0);let t=e.length-1;if(e&&e[0]){const r=e[t];r&&1!==r.ratio&&(e.push(new o({ratio:1,color:r.color})),t++)}return e.map((o,e)=>{let l="";return 0===e?l=r.legendOptions?.minLabel||"low":e===t&&(l=r.legendOptions?.maxLabel||"high"),{color:o.color,label:l,ratio:o.ratio}}).reverse()}export{r as getHeatmapRampStops};

package/legend/support/relationshipRampUtils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{getStroke as t,getFill as o}from"../../symbols/support/gfxUtils.js";import{getSymbolLayerFill as e}from"../../symbols/support/previewSymbol3D.js";const l={HH:315,HL:45,LL:135,LH:225},r={2:[["HL","HH"],["LL","LH"]],3:[["HL","HM","HH"],["ML","MM","MH"],["LL","LM","LH"]],4:[["HL","HM1","HM2","HH"],["M2L","M2M1","M2M2","M2H"],["M1L","M1M1","M1M2","M1H"],["LL","LM1","LM2","LH"]]};function s(l){if(!l)return;const{type:r}=l;if(r.includes("3d"))return e(l.symbolLayers.at(0));if("simple-line"===r){const o=t(l);return o&&o.color}if("simple-marker"===l.type&&("x"===l.style||"cross"===l.style)){const o=t(l);return o&&o.color}return o(l)}function n(t,o){const e=o.HH.label,l=o.LL.label,r=o.HL.label,s=o.LH.label;switch(t){case"HH":default:return{top:e,bottom:l,left:r,right:s};case"HL":return{top:r,bottom:s,left:l,right:e};case"LL":return{top:l,bottom:e,left:s,right:r};case"LH":return{top:s,bottom:r,left:e,right:l}}}function H(t){const{focus:o,infos:e,numClasses:l}=t,H=r[l],i={};e.forEach(t=>{i[t.value]={label:t.label,fill:s(t.symbol)}});const u=[];for(let r=0;r<l;r++){const t=[];for(let o=0;o<l;o++){const e=i[H[r][o]];t.push(e.fill)}u.push(t)}return{type:"relationship-ramp",numClasses:l,focus:o,colors:u,labels:n(o,i),rotation:L(o)}}function L(t){let o=l[t];return t&&null==o&&(o=l.HH),o||0}export{H as getRelationshipRampElement,L as getRotationAngleForFocus};

package/legend/support/sizeRampUtils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import e from"../../Color.js";import{getColorLuminance as t}from"../../core/colorUtils.js";import{getAuthoringInfoVisualVariableByTheme as l,getSymbolForFlowRenderer as i,createStopLabel as o}from"./utils.js";import{round as r,numDigits as s,percentChange as n}from"../../renderers/support/numberUtils.js";import{updateReferenceSizeSymbol as a}from"../../smartMapping/renderers/support/referenceSizeUtils.js";import{updateSpikeSymbol as u}from"../../smartMapping/renderers/support/spikeUtils.js";import{isDarkMode as m}from"../../support/modeUtils.js";import c from"../../symbols/SimpleLineSymbol.js";import p from"../../symbols/SimpleMarkerSymbol.js";import{applyCIMSymbolColor as f}from"../../symbols/support/cimSymbolUtils.js";import{getCIMSymbolPreviewSize as y}from"../../symbols/support/previewCIMSymbol.js";import{isSymbol3D as b}from"../../symbols/support/typeUtils.js";import{isVolumetricSymbol as d,getSymbolOutlineSize as h}from"../../symbols/support/utils.js";const S=30,w=12,g=24,v=[255,255,255],z=[200,200,200],k=[128,128,128],j=20,V=5;function x(e){return"esri.symbols.SimpleMarkerSymbol"===e.declaredClass}function I(e){return"esri.symbols.PictureMarkerSymbol"===e.declaredClass}function M(e){return"esri.symbols.SimpleLineSymbol"===e.declaredClass}function C(e){return"esri.symbols.TextSymbol"===e.declaredClass}function U(e,t,l=!1){const i=e.length-1;return e.map((e,r)=>o(e,r,i,t,l))}async function L(e,t,i,o,s,n,a){const u=t.legendOptions,m=u?.customValues,c=a||await E(e,i),p=t.stops,f=!!c,b=!!m,S=null!=t.minSize&&null!=t.maxSize,w=p&&p.length>1,v=!!t.target;if(!f||!b&&!(S||w&&!v))return;const z=d(c);let k=!1,j=null,V=null;j=z&&!w?r([t.minDataValue,t.maxDataValue]):m??await H(t,c,o,s?.type);const x=e?.authoringInfo,I="univariate-color-size"===x?.type,M=I&&"above-and-below"===x?.univariateTheme,C=l(e,"reference-size"),L=!!C,T=!!l(e,"spike");if(!j&&w&&(j=p.map(e=>e.value),k=p.some(e=>!!e.label),"flow"===e.type&&(j=r(j)),k&&(V=p.map(e=>e.label))),z&&null!=j&&j?.length>2&&!M&&(j=[j[0],j[j.length-1]]),!j)return null;I&&5!==j?.length&&(j=O({minSize:j[0],maxSize:j[j.length-1]}));const P=z?D(e,j):null,q=h(c),B=L&&C?.minSliderValue===j[0],R=k?null:U(j,n,B),A=await Promise.all(j.map(async(l,i)=>{let r=z?P[i]:await F(t,c,l,o,s?.type),n=r;L&&(r*=g/t.maxSize||1,n=g);const a=G(c,r,e,i);T&&"cim"===a.type&&(n=await y(a));return{value:l,symbol:a,label:k?V[i]:R[i],size:n,outlineSize:q}}));return A.reverse()}function D(e,t){const l=e?.authoringInfo,i="univariate-color-size"===l?.type;let o=[w,S];if(i){const e=t[0],l=t[t.length-1],i=w,r=S;o=t.map(t=>i+(t-e)/(l-e)*(r-i))}return i&&"below"===l?.univariateTheme&&o.reverse(),o}function T(e,t){const l=e.classBreakInfos,i=l.length,o=i<2||!(t>=2)?l[0].symbol.clone():l[i-1].symbol.clone(),r=e.visualVariables?.some(e=>"color"===e.type);return r&&(o.type.includes("3d")?q(o):B(o)),o}async function E(o,r){if("flow"===o.type)return i(o,r);if("pie-chart"===o.type)return new p({color:null,outline:o.outline?.width?o.outline:new c});let s=null,n=null;if("simple"===o.type)s=o.symbol;else if("class-breaks"===o.type){const e=o.classBreakInfos;s=e&&e[0]&&e[0].symbol,n=e.length>1}else if("unique-value"===o.type){const e=o.uniqueValueInfos;s=e?.[0]?.symbol,n=null!=e&&e.length>1}if(!s||P(s))return null;if(s=s.clone(),r||n)if(s.type.includes("3d"))q(s);else if(l(o,"reference-size")&&"cim"===s.type)a(s,{color:r??("class-breaks"!==o.type?new e(z):null)});else if(l(o,"spike")&&"cim"===s.type){const l=new e(z),i=new e(k),o="CIMPointSymbol"===s.data.symbol?.type?s.data.symbol:null,n=!!o?.symbolLayers?.find(({type:e})=>"CIMSolidStroke"===e)?.colorLocked;let a,c=r??void 0;if(c){const e=t(c),o=m();(!o&&e>225||o&&e<25)&&(c=l,a=n?i:l)}else c=l,a=n?i:l;u(s,{color:c,strokeColor:a})}else B(s);return s}function P(e){return b(e)?e.symbolLayers?.some(e=>"fill"===e?.type)??!1:e?.type.includes("fill")??!1}function q(e){"line-3d"===e.type?e.symbolLayers.forEach(e=>{e.material={color:k}}):e.symbolLayers.forEach(e=>{"icon"!==e.type||e.resource?.href?e.material={color:z}:(e.material={color:v},e.outline={color:k,size:1.5})})}function B(t){const l=m();if("cim"===t.type)f(t,new e(z));else if(t.type.includes("line"))t.color=k;else if(t.color=l?k:v,"simple-marker"===t.type)if(t.outline){const e=t.outline?.color?.toHex();"#ffffff"===e&&(t.outline.color=k)}else t.outline={color:k,width:1.5}}async function H(e,t,l,i){const o=(await(import("../../renderers/visualVariables/support/visualVariableUtils.js"))).getSizeRangeAtScale(e,l,i),s=o&&O(o);if(!o||!s)return;let n=s.map(t=>R(t,e,o));n=r(n);for(let r=1;r<n.length-1;r++){const o=await A(e,t,n[r],n[r-1],l,i);o&&(n[r]=o[0],s[r]=o[1])}return n}function O(e){const t=e.minSize,l=e.maxSize,i=V,o=(l-t)/(i-1),r=[];for(let s=0;s<i;s++)r.push(t+o*s);return r}function R(e,t,l){const i=l.minSize,o=l.maxSize,r=t.minDataValue,s=t.maxDataValue;let n;if(e<=i)n=r;else if(e>=o)n=s;else{n=(e-i)/(o-i)*(s-r)+r}return n}async function A(e,t,l,i,o,a){const u=await F(e,t,l,o,a),m=await F(e,t,i,o,a),c=s(l),p=c.fractional,f=j;let y=c.integer,b=null,d=null;l>0&&l<1&&(b=10**p,y=s(l*=b).integer);for(let s=y-1;s>=0;s--){const i=10**s;let c=Math.floor(l/i)*i,p=Math.ceil(l/i)*i;null!=b&&(c/=b,p/=b);let y=(c+p)/2;[,y]=r([c,y,p],{indexes:[1]});const h=await F(e,t,c,o,a),S=await F(e,t,p,o,a),w=await F(e,t,y,o,a),g=n(u,h,m,null),v=n(u,S,m,null),z=n(u,w,m,null);let k=g.previous<=f,j=v.previous<=f;if(k&&j&&(g.previous<=v.previous?(k=!0,j=!1):(j=!0,k=!1)),k?d=[c,h]:j?d=[p,S]:z.previous<=f&&(d=[y,w]),d)break}return d}async function F(e,t,l,i,o){const{getSize:r}=await(import("../../renderers/visualVariables/support/visualVariableUtils.js"));return r(e,l,{scale:i,view:o,shape:"simple-marker"===t.type?t.style:null})}function G(e,t,i,o){"univariate-color-size"===i?.authoringInfo?.type&&"above-and-below"===i?.authoringInfo?.univariateTheme&&"class-breaks"===i.type&&(e=T(i,o));const r=e.clone();if(b(r))d(r)||r.symbolLayers.forEach(e=>{"fill"!==e.type&&(e.size=t)});else if(x(r))r.size=t;else if(I(r)){const e=r.width,l=r.height;r.height=t,r.width=t*(e/l)}else M(r)?r.width=t:C(r)?r.font&&(r.font.size=t):"cim"===r.type&&l(i,"reference-size")?a(r,{innerDotSize:t,outerRingSize:g}):"cim"===r.type&&l(i,"spike")&&u(r,{defaultHeight:t,primitiveOverrides:null});return r}export{L as getRampStops,S as realWorldMaxSize,w as realWorldMinSize};

package/legend/support/utils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{convertNumberFieldFormatToIntlOptions as t,convertNumberFormatToIntlOptions as e,formatNumber as n}from"../../intl.js";import{millisecondsPerTimeUnit as i}from"../../core/timeUtils.js";import o from"../../layers/support/DateTimeFieldFormat.js";import{getFieldConfigurationsContainer as r}from"../../layers/support/layerUtils.js";import l from"../../popup/support/FieldInfoFormat.js";import{format as a}from"../../renderers/support/numberUtils.js";import{formatAnyDate as A}from"../../smartMapping/support/utils.js";import s from"../../symbols/SimpleLineSymbol.js";const u="<",f=">";function m(t,e,n,i,o=!1){let r="";0!==e||o?e===n&&(r=`${f} `):r=`${u} `;const l=d(t,i);return null==l?"":r+l}function p(t){const{format:e,fieldFormat:n}=t||{};return"number"===n?.type||!!e&&null==e.dateFormat&&(null!=e.places||null!=e.digitSeparator)}function d(i,o){if(null==i)return i;const{fieldType:r,format:l,fieldFormat:s,timeZoneOptions:u}=o||{};if(U(r))return A(i,{fieldType:r,format:l?.dateFormat,fieldFormat:"date-time"===s?.type?s:void 0,timeZoneOptions:u});if("string"==typeof i&&p(o)){const t=Number(i);isNaN(t)||(i=t)}if("string"==typeof i)return i;const f="number"===s?.type?t(s):l?e(l):void 0;return f?n(i,f):a(i)}const c=["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAACXBIWXMAAAAAAAAAAAHqZRakAAAANUlEQVQ4jWPMy8v7z0BFwMLAwMAwcdIkqhiWn5fHwEQVk5DAqIGjBo4aOGrgqIEQwEjtKgAATl0Hu6JrzFUAAAAASUVORK5CYII=","data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAACXBIWXMAAAAAAAAAAAHqZRakAAAANUlEQVQ4jWPMy8v7z0BFwMLAwMAwaeIkqhiWl5/HwEQVk5DAqIGjBo4aOGrgqIEQwEjtKgAATl0Hu6sKxboAAAAASUVORK5CYII=","data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAACXBIWXMAAAAAAAAAAAHqZRakAAAANUlEQVQ4jWPMy8v7z0BFwMLAwMAwadJEqhiWl5fPwEQVk5DAqIGjBo4aOGrgqIEQwEjtKgAATl0Hu75+IUcAAAAASUVORK5CYII="];async function g(t){if(!("visualVariables"in t)||!t.visualVariables)return null;const e=t.visualVariables.find(t=>"color"===t.type);if(!e)return null;let n=null,i=null;if(e.stops){if(1===e.stops.length)return e.stops[0].color;n=e.stops[0].value,i=e.stops[e.stops.length-1].value}const o=null!=n&&null!=i?n+(i-n)/2:0,{getColor:r}=await(import("../../renderers/visualVariables/support/visualVariableUtils.js"));return r(e,o)??null}async function w(t,e){const n=t.trailCap,i=t.trailWidth||1,o=e||await g(t)||t.color;return new s({cap:n,color:o,width:i})}function y(t,e){if(!e)return null;if("featureReduction"in t)switch(t.featureReduction?.type){case"cluster":case"binning":{const n=t.featureReduction.fields.find(({name:t})=>t.toLowerCase()===e.toLowerCase());return n?.type?n:n&&"getField"in t?t.getField(n.onStatisticField):null}}return"getField"in t?t.getField?.(e):null}function I(t,e){const n="popupTemplate"in t?t.popupTemplate?.fieldInfos:null;if(n?.length&&e)return n.find(t=>t.fieldName?.toLowerCase()===e.toLowerCase())}function F(t){let e=0,n=0;return t.stops?(e=t.stops?.at(0)?.value??e,n=t.stops?.at(-1)?.value??n):"minDataValue"in t&&"maxDataValue"in t&&(e=t.minDataValue??e,n=t.maxDataValue??n),n-e>2*i.days?"short-date":"short-date-short-time"}function U(t){return["date","date-only","time-only","timestamp-offset"].includes(t||"")}function h(t,e,n){const i=C(t,e.field,n);return i?(U(i.fieldType)&&(i.fieldConfigurationsContainer?i.fieldFormat??=new o({dateStyle:"short",timeStyle:"short-date-short-time"===F(e)?"short":null}):i.format??=new l({dateFormat:F(e)})),i):null}function C(t,e,n){const i=y(t,e),o=i?.name;if(!o)return null;const l=i?.type,a=r(t,{checkFeatureReduction:!0});return{fieldType:l,format:a?null:I(t,o)?.format,fieldFormat:a?a.getFieldConfiguration(o)?.fieldFormat:null,fieldConfigurationsContainer:a,timeZoneOptions:U(l)?{layerTimeZone:"preferredTimeZone"in t?t.preferredTimeZone:null,viewTimeZone:n,datesInUnknownTimezone:"datesInUnknownTimezone"in t&&t.datesInUnknownTimezone}:null}}function V(t,e){if("authoringInfo"in t)return t.authoringInfo?.visualVariables?.find(({theme:t})=>t===e)}function j(t,e){let n=null!=t?t:"";return null!=e&&e&&(n=n?"("+n+") AND ("+e+")":e),n}export{m as createStopLabel,d as formatValue,V as getAuthoringInfoVisualVariableByTheme,C as getFormatOptions,h as getFormatOptionsForVisualVariable,g as getMedianColor,w as getSymbolForFlowRenderer,j as mergeWhereClauses,c as rgbImgSource,f as specialCharsGreaterThan,u as specialCharsLessThan};

package/legend/types.d.ts

@@ -0,0 +1,403 @@
+/**
+ * Public types used to configure [LegendContent](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/) and describe the legend elements generated by
+ * [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/).
+ *
+ * These types can be used when rendering a custom legend independently of the Legend component.
+ *
+ * @since 5.2
+ */
+import type Color from "../Color.js";
+import type Layer from "../layers/Layer.js";
+import type Sublayer from "../layers/support/Sublayer.js";
+import type { RelationshipFocus } from "../renderers/support/types.js";
+import type { SymbolUnion } from "../symbols/types.js";
+
+/** Describes the schema of the ClusterTitle element. */
+export interface ClusterTitle {
+  /** Whether to show the count. */
+  showCount: boolean;
+}
+
+/** Describes the schema of the ColorRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface ColorRampElement {
+  /** The type of this element is always `color-ramp`. */
+  type: "color-ramp";
+  /** The title of the color ramp as displayed in the legend. */
+  title?: RampTitle | string | null;
+  /**
+   * The
+   *   individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
+   */
+  infos: ColorRampStop[];
+  /** A preview of the element as displayed in the legend. */
+  preview?: HTMLElement | null;
+}
+
+/**
+ * Describes the schema of the ColorRampStop element. Each ColorRampStop represents a single stop of the
+ * [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) referenced in the renderer.
+ */
+export interface ColorRampStop {
+  /** The value of the color visual variable [stop](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/#stops). */
+  value: number | string | null;
+  /** The color of the visual variable [stop](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/#stops). */
+  color: Color;
+  /** The label in the legend describing features with the given `color` and `value`. */
+  label: string | null;
+}
+
+/** Describes the schema of the DotDensityTitle element. */
+export interface DotDensityTitle {
+  /** The value. */
+  value: number;
+  /** The unit. */
+  unit?: string | null;
+}
+
+/** Describes the schema of the HeatmapRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface HeatmapRampElement {
+  /** The type of this element is always `heatmap-ramp`. */
+  type: "heatmap-ramp";
+  /** The title of the heatmap ramp as displayed in the legend. */
+  title?: RendererTitle | string | null;
+  /**
+   * The
+   *   individual color stops rendered in the legend that correspond to the heatmap colorStops in the renderer.
+   */
+  infos: HeatmapRampStop[];
+  /** A preview of the element as displayed in the legend. */
+  preview?: HTMLElement | null;
+}
+
+/**
+ * Describes the schema of the HeatmapRampStop element. Each HeatmapRampStop represents a single `colorStop` of the
+ * [Heatmap color stops](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/#colorStops) referenced in the renderer.
+ */
+export interface HeatmapRampStop {
+  /**
+   * The color of the pixel corresponding to the appropriate pixel `ratio`. This value is typically
+   *   between `0` and `1`.
+   */
+  color: Color;
+  /**
+   * The ratio of a pixel's intensity value to the minPixelIntensity of the renderer.
+   *   The ratio of each pixel is matched to the corresponding color.
+   */
+  ratio: number;
+  /**
+   * The label of the color stop displayed in the legend. Typically only the first and last
+   *   stops have labels.
+   */
+  label: string;
+}
+
+/**
+ * Properties defining the scheme of an ImageSymbolTableElementInfo. This applies only to
+ * ImageryLayer renderers.
+ */
+export interface ImageSymbolTableElementInfo {
+  /** The label of the category corresponding to the given image. */
+  label?: StretchMultibandTitle | string | null;
+  /** The data URI of the image representing a colored pixel in the renderer. */
+  src: string;
+  /** A preview of the image as displayed in the legend. */
+  preview?: HTMLElement | null;
+  /** The aria-label for the preview element. */
+  previewAriaLabel?: RendererTitle | DotDensityTitle | string | null;
+  /** The opacity of the image (`0` to `1`). */
+  opacity?: number | null;
+  /** The width of the image in pixels. */
+  width?: number | null;
+  /** The height of the image in pixels. */
+  height?: number | null;
+}
+
+/**
+ * An object that defines a layer, optional sublayer IDs, and a custom title for legend display.
+ * Use this to specify which layers and sublayers appear in the legend and how they are labeled with
+ * [layerInfos](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/#layerInfos).
+ */
+export interface LayerInfo {
+  /** A layer to display in the legend. */
+  layer: Layer | Sublayer;
+  /**
+   * Specifies a title for the layer to display above its symbols and descriptions.
+   * If no title is specified the service name is used.
+   */
+  title: string;
+  /**
+   * The IDs of the sublayers for which to display legend information.
+   * Only applicable if the `layer` is a [MapImageLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/), [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SubtypeGroupLayer/)
+   * or [WMSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WMSLayer/).
+   */
+  sublayerIds?: number[];
+}
+
+/** The allowed color names used in multilayer stretch legends. */
+export type LegendColorName = "red" | "green" | "blue";
+
+/** Represents the allowed values for the [LegendContent.state](https://developers.arcgis.com/javascript/latest/references/core/legend/LegendContent/#state) property. */
+export type LegendContentState = "ready" | "disabled";
+
+/** Properties defining the scheme of each supported [legend element](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export type LegendElement = SymbolTableElement | ColorRampElement | StretchRampElement | OpacityRampElement | SizeRampElement | HeatmapRampElement | RelationshipRampElement | UnivariateColorSizeRampElement | PieChartRampElement;
+
+/** Describes the schema of the OpacityRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface OpacityRampElement {
+  /** The type of this element is always `opacity-ramp`. */
+  type: "opacity-ramp";
+  /** The title of the opacity ramp as displayed in the legend. */
+  title?: RampTitle | string | null;
+  /**
+   * The
+   *   individual opacity stops rendered in the legend that correspond to the opacity visual variable in the renderer.
+   */
+  infos: OpacityRampStop[];
+  /** A preview of the element as displayed in the legend. */
+  preview?: HTMLElement | null;
+}
+
+/**
+ * Describes the schema of the OpacityRampStop element. Each OpacityRampStop represents a single stop of the
+ * [OpacityVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/) referenced in the renderer. The opacity value of
+ * each stop is indicated in the [alpha](https://developers.arcgis.com/javascript/latest/references/core/Color/#a) property of the `color` object.
+ */
+export interface OpacityRampStop {
+  /** The value of the opacity visual variable [stop](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/#stops). */
+  value: number;
+  /**
+   * The color of the visual variable [stop](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/#stops).
+   *   The opacity corresponding to the given `value` is indicated in the [alpha](https://developers.arcgis.com/javascript/latest/references/core/Color/#a) property of the color object.
+   */
+  color: Color;
+  /** The label in the legend describing features with the given `color` and `value`. */
+  label: string;
+}
+
+/** Describes the schema of the PieChartRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface PieChartRampElement {
+  /** The type of this element is always `pie-chart-ramp`. */
+  type: "pie-chart-ramp";
+  /** The title of the color ramp as displayed in the legend. */
+  title?: RendererTitle | string | null;
+  /**
+   * The
+   *   individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
+   */
+  infos: SymbolTableElementInfo[];
+  /** A preview of the element as displayed in the legend. */
+  preview?: HTMLElement | null;
+}
+
+/**
+ * Describes the schema of the RelationshipLabels element. These labels are rendered in the corners of the square
+ * that represent the relationship renderer in the legend.
+ */
+export interface RelationshipLabels {
+  /**
+   * The label corresponding with the top corner of the legend if the focus
+   *   is set to `HH`. This
+   *   describes values that are considered high in both field 1 and field 2 (HH).
+   */
+  top: string;
+  /**
+   * The label corresponding with the bottom corner of the legend if the focus is
+   *   set to `HH`. This
+   *   describes values that are considered low in both field 1 and field 2 (LL).
+   */
+  bottom: string;
+  /**
+   * The label corresponding with the left corner of the legend (if the focus
+   *   is set to `HH`). This describes features where the value of field 1 is high and the value of field 2 is low (HL).
+   */
+  left: string;
+  /** The label corresponding with the right corner of the legend. */
+  right: string;
+}
+
+/** Describes the schema of the RelationshipRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface RelationshipRampElement {
+  /** The type of this element is always `relationship-ramp`. */
+  type: "relationship-ramp";
+  /**
+   * The number of classes for each field comprising the renderer. Can either
+   *   be 2, 3, or 4.
+   */
+  numClasses: number;
+  /** Determines the orientation of the Legend. Values can be `HH`, `HL`, `LH`, `LL`. */
+  focus: RelationshipFocus;
+  /** A 2-dimensional array of colors as displayed in the legend grid. */
+  colors: Color[][];
+  /**
+   * The labels for
+   *   each corner of the legend.
+   */
+  labels: RelationshipLabels;
+  /**
+   * The rotation of the legend in degrees (0-360). `0` degrees displays the legend
+   *   as a square with the `LL` cell in the bottom left corner of the legend and the `HH` cell in the top right corner.
+   */
+  rotation: number;
+  /** The title of the renderer as displayed in the legend. */
+  title?: string | null;
+  /** Info objects associated with the relationship renderer. */
+  infos?: any[] | null;
+}
+
+/** Describes the schema of the RampTitle element. */
+export interface RampTitle {
+  /**
+   * The field name used in a visual variable of a renderer. This is used in the
+   *   generated title of the corresponding ramp in the legend.
+   */
+  field?: string | null;
+  /**
+   * If provided, the normalization field name used in a visual variable of a renderer.
+   *   This is used in the generated title of the corresponding ramp in the legend.
+   */
+  normField?: string | null;
+  /** If `true`, the legend formats to display the field and normalization field as a ratio. */
+  ratio: boolean;
+  /** If `true`, the legend formats to display the field and normalization field as a percentage. */
+  ratioPercent: boolean;
+  /** If `true`, the legend formats to display the field and normalization field as a percentage of total. */
+  ratioPercentTotal: boolean;
+}
+
+/** Describes the schema of the RendererTitle element. */
+export interface RendererTitle {
+  /** The title of the renderer as displayed in the legend. */
+  title?: string | null;
+  /**
+   * The field name used in the renderer. This is used in the
+   *   generated title of the renderer in the legend.
+   */
+  field?: string | null;
+  /**
+   * If a normalization field is provided to the renderer, this field
+   *   is also used in the generated title for the renderer in the legend.
+   */
+  normField?: string | null;
+  /**
+   * Indicates if a percentage is used in the normalization of the
+   *   renderer. This is used to create a more readable legend for that scenario.
+   */
+  normByPct?: boolean | null;
+}
+
+/** Describes the schema of the SizeRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface SizeRampElement {
+  /** The type of this element is always `size-ramp`. */
+  type: "size-ramp";
+  /** The title of the size ramp as displayed in the legend. */
+  title?: ClusterTitle | RampTitle | string | null;
+  /**
+   * The
+   *   individual size stops rendered in the legend that correspond to the size visual variable in the renderer.
+   */
+  infos: SizeRampStop[];
+  /** The theme of this element. */
+  theme?: "spike" | null;
+}
+
+/**
+ * Describes the schema of the SizeRampStop element. Each SizeRampStop represents a single stop of the
+ * [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) referenced in the renderer.
+ */
+export interface SizeRampStop {
+  /** The label in the legend describing features with the given `symbol` and `value`. */
+  label: string;
+  /** The value of the size visual variable [stop](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#stops). */
+  value?: any | null;
+  /** The symbol corresponding to the value of the stop in the renderer. */
+  symbol: SymbolUnion;
+  /** The size of the visual variable [stop](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#stops) in points. */
+  size?: number | {
+      width: number;
+      height: number;
+  } | null;
+  /** The width of the outline in points. */
+  outlineSize?: number | null;
+  /** The HTML element rendered in the legend representing features with the given value. */
+  preview?: HTMLElement | null;
+}
+
+/** Describes the schema of the StretchMultibandTitle element. */
+export interface StretchMultibandTitle {
+  /** The color name. */
+  colorName: string;
+  /** The band name. */
+  bandName: string;
+}
+
+/** Describes the schema of the StretchRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface StretchRampElement {
+  /** The type of this element is always `stretch-ramp`. */
+  type: "stretch-ramp";
+  /** The title of the color ramp as displayed in the legend. */
+  title?: RampTitle | string | null;
+  /**
+   * The
+   *   individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
+   */
+  infos: ColorRampStop[];
+  /** A preview of the element as displayed in the legend. */
+  preview?: HTMLElement | null;
+}
+
+/**
+ * Describes the schema of the SymbolTableElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). This
+ * legend element is used for [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/UniqueValueRenderer/) and
+ * [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).
+ */
+export interface SymbolTableElement {
+  /** The type of this element is always `symbol-table`. */
+  type: "symbol-table";
+  /** The title of the renderer as displayed in the legend. */
+  title?: RendererTitle | DotDensityTitle | string | null;
+  /**
+   * An
+   *   array of each symbol/category/break rendered for the symbol table. For example, this may be individual
+   *   breaks for a ClassBreaksRenderer, or unique values for a UniqueValueRenderer.
+   */
+  infos: SymbolTableElementType[];
+  /**
+   * Only used for renderers set to ImageryLayers. Indicates the type of
+   *   renderer set on the layer (e.g. `stretched` or `Unique Values`).
+   */
+  legendType?: string | null;
+}
+
+/** Properties defining the scheme of the SymbolTableElementInfo. */
+export interface SymbolTableElementInfo {
+  /** The symbol for the corresponding `value` in the legend. */
+  symbol: SymbolUnion;
+  /** The label of the symbol element as displayed in the legend. */
+  label?: RampTitle | string | null;
+  /** The value corresponding with the given `symbol` in the legend. */
+  value?: any;
+  /** The size of the symbol in points. */
+  size?: number | null;
+  /** A preview of the symbol element as displayed in the legend. */
+  preview?: HTMLElement | null;
+  /** The aria-label for the preview element. */
+  previewAriaLabel?: RendererTitle | DotDensityTitle | string | null;
+}
+
+/** Represents the allowed element types in a [legend element](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements) symbol table. */
+export type SymbolTableElementType = ImageSymbolTableElementInfo | SymbolTableElementInfo | LegendElement;
+
+/** Describes the schema of the UnivariateColorSizeRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/references/core/legend/ActiveLayerInfo/#legendElements). */
+export interface UnivariateColorSizeRampElement {
+  /** The type of this element is `univariate-above-and-below-ramp` or `univariate-color-size-ramp`. */
+  type: "univariate-above-and-below-ramp" | "univariate-color-size-ramp";
+  /** The title of the color ramp as displayed in the legend. */
+  title?: ClusterTitle | RampTitle | string | null;
+  /**
+   * The
+   *   individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
+   */
+  infos: (SizeRampElement | ColorRampElement)[];
+  /** A preview of the element as displayed in the legend. */
+  preview?: HTMLElement | null;
+}

package/libs/i3s/I3SModule.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{getAssetUrl as t}from"../../assets.js";function s(){return n??=(async()=>{const s=await(import("../../chunks/i3s.js"));return await s.default({locateFile:s=>t(`esri/libs/i3s/${s}`)})})(),n}function i(){n=null}let n;export{i as cleanup,s as get};
+import{getAssetUrl as t}from"../../assets.js";function s(){return r??=(async()=>{try{const s=await(import("../../chunks/i3s.js"));return await s.default({locateFile:s=>t(`esri/libs/i3s/${s}`)})}catch(s){throw i(),s}})(),r}function i(){r=null}let r;export{i as cleanup,s as get};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/core",
-  "version": "5.2.0-next.120",
+  "version": "5.2.0-next.121",
   "description": "ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API",
   "keywords": [
     "ArcGIS",
@@ -20,13 +20,13 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@amcharts/amcharts5": "~5.20.7",
-    "@arcgis/toolkit": "5.2.0-next.120",
+    "@arcgis/toolkit": "5.2.0-next.121",
     "@esri/arcgis-html-sanitizer": "~4.1.0",
-    "@esri/calcite-components": "^5.2.0-next.73",
-    "@vaadin/grid": "~25.2.11",
+    "@esri/calcite-components": "^5.2.0-next.80",
+    "@vaadin/grid": "~25.3.0",
     "@zip.js/zip.js": "~2.17.0",
     "luxon": "~3.7.2",
-    "marked": "~18.0.13",
+    "marked": "~18.0.14",
     "tslib": "^2.8.1"
   }
 }