@geoscene/map-components 4.33.20 → 4.34.9

package/dist/components/geoscene-legend/customElement.d.ts

@@ -1,126 +1,355 @@
 /// <reference types="@geoscene/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
+/// <reference path="../../index.d.ts" />
+import { default as LegendViewModel } from '@geoscene/core/widgets/Legend/LegendViewModel.js';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@geoscene/lumina';
 import { Use } from '@geoscene/lumina/controllers';
-import { default as Legend } from '@geoscene/core/widgets/Legend.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@geoscene/lumina';
+import { HeadingLevel } from '../../support/heading';
 import { GeosceneReferenceElement } from '../../utils/component-utils';
 
-declare const useLegendWidget: (component: LitElement & Pick<Legend, "icon" | "label" | "viewModel" | "headingLevel" | "activeLayerInfos" | "basemapLegendVisible" | "hideLayersNotInCurrentView" | "layerInfos" | "respectLayerDefinitionExpression"> & {
-    state?: unknown;
-    viewModel?: __geoscene.LegendViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/components-utils').Nil | string;
-    label: import('@arcgis/components-utils').Nil | string;
-    referenceElement?: GeosceneReferenceElement | string;
-    position: __geoscene.UIPosition;
-    geosceneReady: import('@geoscene/lumina').EventEmitter;
-    geoscenePropertyChange: import('@geoscene/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __geoscene.LinkChartView | __geoscene.MapView | __geoscene.SceneView;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => Legend;
+declare const useLegendViewModel: (component: LitElement & Pick<LegendViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<LegendViewModel>) => LegendViewModel;
 /**
- * The Legend component describes the symbols used to represent layers in a map.
+ * The Legend component displays the symbols and labels used to represent layers in a [geoscene-map](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-map/) or [geoscene-scene](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-scene/).
+ * Only layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#ignoreLayerVisibility) is set to `true`.
+ *
+ * The legend automatically updates when:
+ *  - the visibility of a layer or sublayer changes
+ *  - a layer is added or removed from the map
+ *  - a layer's `renderer`, `opacity`, or `title` is changed
+ *  - the `legendEnabled` property is changed (set to `true` or `false` on the layer)
+ *
+ * ## Known Limitations
+ *
+ * * Currently, the legend component does not support the following layer types:
+ * [ElevationLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html),
+ * [GraphicsLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html),
+ * [IntegratedMeshLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html),
+ * [KMLLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html),
+ * [MapNotesLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html),
+ * [OpenStreetMapLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OpenStreetMapLayer.html),
+ * [VectorTileLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html),
+ * [VideoLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html), and
+ * [WebTileLayer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html).
+ * * [Symbol3D](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html) with more than one
+ * [symbol](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html) are not supported.
+ * * [DictionaryRenderer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html) is not supported.
+ * * [TrackInfo](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html) is not supported.
+ * * CIM Symbol [primitiveOverride](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#PrimitiveOverride) is not supported.
+ * * RasterStretchRenderer [dynamicRangeAdjustment](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment) is not supported.
+ *
+ * ## Various examples of legends based on renderer type.
+ *
+ * ### Unique values
+ *
+ * [![Unique values](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-unique-values.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-location-types/)
+ *
+ * ### Continuous color
+ *
+ * [![Continuous color](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-color-vv.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-vv-color/)
+ *
+ * ### Classed color
+ *
+ * [![Classed color](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-class-breaks.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-classbreaks/)
+ *
+ * ### Continuous size
+ *
+ * [![Continuous size](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-size.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-sm-size/)
+ *
+ * ### Size - above and below
+ *
+ * [![Size - above and below](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-size-themes.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-sm-size-themes/)
+ *
+ * ### Dot density
+ *
+ * [![Dot density](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-dot-density.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-dot-density/)
+ *
+ * ### Predominance
+ *
+ * [![Predominance](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-predominance.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-arcade/)
+ *
+ * ### Relationship
+ *
+ * [![Relationship](https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/legend/legend-relationship.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/visualization-sm-relationship/)
+ *
+ *
+ * ## Legend labels
+ *
+ * Legend text is directly controlled through the [layer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html) and [renderer](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html) properties. For example, `layer.title` is directly used by the legend to present a layer's symbology to the end user. To override this text, you can directly update `layer.title`.
+ *
+ * Furthermore, you can control date and number formatting in Legend by using the [FieldConfiguration](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FieldConfiguration.html) formatting options on the layer. As an alternative to this, you can override Legend text via the renderer's properties. For example, the renderer may have a [legendOptions](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#legendOptions) property (or a label property in the case of visual variable stops or UniqueValueInfos) that can be used to override default legend text describing the renderer element in question. The [Update legend text sample](https://doc.geoscene.cn/javascript/4.33/sample-code/legend-update/) provides an example of overriding legend text via the renderer.
+ *
+ * Note that when you override legend text, all formatting and localization that would otherwise be dynamically applied to labels will no longer apply.
  *
  * [Read more...](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/)
+ *
+ * @see [Sample - Legend component](https://doc.geoscene.cn/javascript/4.33/sample-code/legend/)
+ * @see [Sample - Add a Legend to the LayerList](https://doc.geoscene.cn/javascript/4.33/sample-code/layerlist-legend/)
+ * @see [Sample - Legend component card style](https://doc.geoscene.cn/javascript/4.33/sample-code/legend-card/)
+ * @see [Sample - Update legend text](https://doc.geoscene.cn/javascript/4.33/sample-code/legend-update/)
+ * @since 4.28
  */
 export declare class GeosceneLegend extends LitElement {
     /**
-     * Collection of [ActiveLayerInfo](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to
-     * display data in the legend.
+     * The view associated with the component.
+     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Legend component will be associated with a map or scene component rather than using the `view` property.
+     */
+    view?: __geoscene.MapView | __geoscene.SceneView | nullish;
+    /**
+     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
      *
-     * [Read more...](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#activeLayerInfos)
+     * @see [Associate components with a Map or Scene component](https://doc.geoscene.cn/javascript/4.33/programming-patterns/#associate-components-with-a-map-or-scene-component)
      */
-    activeLayerInfos: __geoscene.Collection<__geoscene.ActiveLayerInfo>;
+    referenceElement?: GeosceneReferenceElement | string;
+    /** @deprecated since 4.34, use [`slot`](https://doc.geoscene.cn/javascript/4.33/building-your-ui/#slots) instead. */
+    position?: __geoscene.UIPosition;
     /**
-     * If true, the component will not be destroyed automatically when it is
-     * disconnected from the document. This is useful when you want to move the
-     * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the [destroy](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#destroy) method when you are done to
-     * prevent memory leaks.
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * @default false
+     * @see [Calcite Icons](https://doc.geoscene.cn/calcite-design-system/icons/)
+     * @default "legend"
      */
-    autoDestroyDisabled: boolean;
+    icon?: string;
     /**
-     * Indicates whether to show the [Basemap](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html) layers in the Legend.
+     * Collection of [ActiveLayerInfo](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to
+     * display data in the legend. The legend component watches this property to hide or display the layer's legend when
+     * an [ActiveLayerInfo](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html) is removed from or added to this collection.
      *
+     * @autocast { "value": "Object[]", "typedCollection": true }
+     */
+    activeLayerInfos: __geoscene.Collection<__geoscene.ActiveLayerInfo>;
+    /**
+     * Indicates whether to show the [Basemap](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html) layers in the Legend. If you set this property to
+     * `true` and specify [layerInfos](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#layerInfos) that include the basemap layers, the basemap will be displayed in the legend.
+     *
+     * @example
+     * Show basemap layers in the legend
+     *
+     * ```js
+     * const mapElement = document.querySelector("geoscene-map");
+     * const basemapLayer = mapElement.map.basemap.baseLayers.getItemAt(0);
+     * const legend = document.querySelector("geoscene-legend");
+     * legend.layerInfos = [{ layer: basemapLayer }];
+     * legend.basemapLegendVisible = true;
+     * ```
      * @default false
      */
     basemapLegendVisible: boolean;
     /**
-     * Indicates the heading level to use for the legend title.
+     * Indicates the heading level to use for the legend title. By default, legend titles are rendered as level 3 headings (e.g. `<h3>Legend title</h3>`). Depending on the legend placement
+     * in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
+     *
+     * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+     * @example
+     * Legend title will render as an `<h2>`
+     *
+     * ```html
+     * <geoscene-legend heading-level="2"></geoscene-legend>
+     * ```
      *
+     * ```js
+     * document.querySelector("geoscene-legend").headingLevel = 2;
+     * ```
      * @default 3
      */
-    headingLevel: number;
+    headingLevel: HeadingLevel;
     /**
-     * When `true`, layers will only be shown in the legend if
-     * they are visible in the view's extent.
+     * 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. Only layers that implement the `createQuery()`
+     * and `queryFeatureCount()` methods are supported by `hideLayersNotInCurrentView`.
      *
+     * To hide layers completely from the legend, you should set the `legendEnabled` property of the layer to `false`.
+     *
+     * @see [ignoreLayerVisibility](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#ignoreLayerVisibility)
+     * @example
+     * Layers not displayed in the current map extent will not be shown in the legend
+     *
+     * ```html
+     * <geoscene-legend hide-layers-not-in-current-view></geoscene-legend>
+     * ```
+     *
+     * ```js
+     * document.querySelector("geoscene-legend").hideLayersNotInCurrentView = true;
+     * ```
      * @default false
      */
     hideLayersNotInCurrentView: boolean;
     /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
+     * If a layer uses a unique value render, only features that satisfy the layer's
+     * [definition](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression)
+     * will be displayed in the legend when set to true.
      *
-     * @see [Calcite Icons](https://doc.geoscene.cn/calcite-design-system/icons/)
-     * @default "legend"
+     * @since 4.30
+     * @see [definitionExpression](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression)
+     * @example
+     * Only display features that satisfy the layer's definitionExpression.
+     *
+     * ```html
+     * <geoscene-legend respect-layer-definition-expression></geoscene-legend>
+     * ```
+     *
+     * ```js
+     * document.querySelector("geoscene-legend").respectLayerDefinitionExpression = true;
+     * ```
+     * @default false
      */
-    icon: string;
+    respectLayerDefinitionExpression: boolean;
     /**
-     * The widget's default label.
+     * 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 layer's [legendEnabled](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#legendEnabled) property
+     * is set to `false`.
+     * - If the view's scale is outside the visibility range
+     * defined by the layer's [minScale](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#minScale) and
+     * [maxScale](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#maxScale) properties.
      *
-     * [Read more...](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#label)
+     * When the `ignoreLayerVisibility` property of the legend is set to `true`, 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.
+     *
+     * @since 4.34
+     * @see [hideLayersNotInCurrentView](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#hideLayersNotInCurrentView)
+     * @example
+     * Always displays legend elements for the map's layers regardless of their minScale, maxScale, and legendEnabled properties.
+     *
+     * ```html
+     * <geoscene-legend ignore-layer-visibility></geoscene-legend>
+     * ```
+     *
+     * ```js
+     * document.querySelector("geoscene-legend").ignoreLayerVisibility = true;
+     * ```
+     * @default false
      */
-    label: string;
+    get ignoreLayerVisibility(): boolean;
+    set ignoreLayerVisibility(value: boolean);
     /**
-     * Specifies a subset of the layers to display in the legend.
+     * 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 layer's [legendEnabled](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#legendEnabled) property
+     * is set to `false`.
+     * - If the view's scale is outside the visibility range
+     * defined by the layer's [minScale](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#minScale) and
+     * [maxScale](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#maxScale) properties.
+     *
+     * When the `respectLayerVisibilityDisabled` 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.
+     *
+     * @see [ignoreLayerVisibility](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#ignoreLayerVisibility)
+     * @example
+     * Always displays legend elements for the map's layers regardless of their minScale, maxScale, and legendEnabled properties.
      *
-     * [Read more...](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#layerInfos)
+     * ```html
+     * <geoscene-legend respect-layer-visibility-disabled="false"></geoscene-legend>
+     * ```
+     *
+     * ```js
+     * document.querySelector("geoscene-legend").respectLayerVisibilityDisabled = true;
+     * ```
+     * @deprecated since 4.34 use [ignoreLayerVisibility](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#ignoreLayerVisibility) instead.
+     * @default false
      */
-    layerInfos: __geoscene.LegendLayerInfos[];
+    get respectLayerVisibilityDisabled(): boolean;
+    set respectLayerVisibilityDisabled(value: boolean);
     /**
-     * Indicates the style of the legend.
+     * Specifies a subset of the layers to display in the legend. This includes any basemap layers
+     * you want to be visible in the legend.  If this property is not set, all layers in the map will display in the legend, including
+     * basemap layers if [basemapLegendVisible](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#basemapLegendVisible) is `true`. Objects in this array are defined with the properties in the example below.
      *
-     * [Read more...](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#style)
+     * @example
+     * Only show a specific sublayer in the legend
      *
-     * @default "classic"
+     * ```js
+     * const subtypeGroupLayer = webmap.layers.getItemAt(0);
+     * const subtypeSubLayer = subtypeGroupLayer.sublayers.getItemAt(1);
+     * const subtypeSublayerId = parseInt(subtypeSubLayer.subtypeCode);
+     * document.querySelector("geoscene-legend").layerInfos = [
+     *   {
+     *     layer: subtypeGroupLayer,
+     *     sublayerIds: [subtypeSublayerId]
+     *   }
+     * ];
+     * });
+     * ```
      */
-    legendStyle: string | __geoscene.LegendStyle;
-    /** @default "bottom-left" */
-    position: __geoscene.UIPosition;
+    layerInfos: __geoscene.LegendViewModelLayerInfo[];
     /**
-     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
+     * Indicates whether the legend is currently loading.
      *
-     * @see [Associate components with a Map or Scene component](https://doc.geoscene.cn/javascript/4.33/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     * @since 4.34
+     * @default false
      */
-    referenceElement?: GeosceneReferenceElement | string;
+    readonly loading: boolean;
     /**
-     * If a layer uses a unique value render, only features that satisfy the layer's
-     * [definition expression](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression)
-     * will be displayed in the legend when set to true.
+     * Indicates the layout of the legend when the [legendStyle](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#legendStyle) is set to the string value of `"card"`.
+     * The layout determines how the legend's content is arranged.
      *
-     * @default false
+     * [![card-style-layout](https://doc.geoscene.cn/javascript/4.33/assets/img/components/legend/card-style-layout.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/legend-card/)
+     *
+     * @since 4.34
+     * @example
+     * Renders the legend in the card style with a "stack" layout
+     *
+     * ```html
+     * <geoscene-legend legend-style="card" card-style-layout="stack"></geoscene-legend>
+     * ```
+     *
+     * ```js
+     * const legend = document.querySelector("geoscene-legend");
+     * legend.legendStyle = "card";
+     * legend.cardStyleLayout = "stack";
+     * ```
      */
-    respectLayerDefinitionExpression: boolean;
+    cardStyleLayout?: "auto" | "side-by-side" | "stack";
     /**
-     * Determines whether to respect the properties of the layers in the map that
-     * control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).
+     * Indicates the style of the legend. The style determines the legend's layout and behavior.
+     * You can either specify a string or an object to indicate the style. The known string values are the same values listed in
+     * the table within the `type` property.
+     *
+     * [![legend-style](https://doc.geoscene.cn/javascript/4.33/assets/img/components/legend/legend-style.png)](https://doc.geoscene.cn/javascript/4.33/sample-code/legend-card/)
      *
-     * [Read more...](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#respectLayerVisibility)
+     * @see [cardStyleLayout](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#cardStyleLayout)
+     * @example
+     * Renders the legend in the card style with a stack layout
+     *
+     * ```js
+     * document.querySelector("geoscene-legend").legendStyle = {
+     *   type: "card",
+     *   layout: "stack"
+     * };
+     * ```
+     * @default "classic"
+     */
+    legendStyle: "card" | "classic" | {
+        type: "card" | "classic";
+        layout?: "auto" | "side-by-side" | "stack";
+    };
+    /**
+     * If true, the component will not be destroyed automatically when it is
+     * disconnected from the document. This is useful when you want to move the
+     * component to a different place on the page, or temporarily hide it. If this
+     * is set, make sure to call the [destroy](https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/#destroy) method when you are done to
+     * prevent memory leaks.
      *
      * @default false
      */
-    respectLayerVisibilityDisabled: boolean;
+    autoDestroyDisabled: boolean;
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     *
+     * @since 4.34
+     */
+    messageOverrides?: typeof this.messages._overrides;
+    /**
+     * The component's default label.
+     *
+     * @default "Legend"
+     */
+    label?: string;
     /**
      * The current state of the component.
      *
@@ -133,7 +362,8 @@ export declare class GeosceneLegend extends LitElement {
     readonly geoscenePropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly geosceneReady: TargetedEvent<this, void>;
+    private messages;
 }
 export {};

package/dist/components/geoscene-legend/customElement.js

@@ -1,31 +1,74 @@
-import { c as e } from "../../chunks/runtime.js";
-import { usePropertyChange as t } from "@geoscene/lumina/controllers";
-import i from "@geoscene/core/widgets/Legend.js";
-import { LitElement as s, createEvent as r, noShadowRoot as a } from "@geoscene/lumina";
-import { m as o } from "../../chunks/useWidget.js";
-import { css as n } from "@lit/reactive-element/css-tag.js";
+import { c as l } from "../../chunks/runtime.js";
+import { css as d, html as r } from "lit";
+import { on as o, watch as s } from "@geoscene/core/core/reactiveUtils.js";
+import c from "@geoscene/core/widgets/Legend/LegendViewModel.js";
+import { LitElement as g, createEvent as h, safeClassMap as p } from "@geoscene/lumina";
+import { usePropertyChange as u } from "@geoscene/lumina/controllers";
+import { classes as f } from "@arcgis/toolkit/dom";
+import { u as _ } from "../../chunks/useHandles.js";
+import { u as m } from "../../chunks/useT9n.js";
+import { m as v } from "../../chunks/useViewModel.js";
+import { g as a } from "../../chunks/globalCss.js";
 /*! All material copyright GeoScene, All Rights Reserved, unless otherwise specified.
-See https://js.geoscene.cn/4.33/geoscene/copyright.txt for details.
-v4.33.18 */
-const l = n`@layer{geoscene-legend{display:block}}`, d = o(i);
-class h extends s {
+See https://js.geoscene.cn/4.34/geoscene/copyright.txt for details.
+v4.34.9 */
+const w = d`.geoscene-widget__heading{color:var(--calcite-color-text-2);margin:0 0 .5rem;font-weight:var(--calcite-font-weight-semibold)}h1.geoscene-widget__heading{font-size:var(--calcite-font-size-xl)}h2.geoscene-widget__heading{font-size:var(--calcite-font-size-md)}h3.geoscene-widget__heading,h4.geoscene-widget__heading,h5.geoscene-widget__heading,h6.geoscene-widget__heading{font-size:var(--calcite-font-size)}.geoscene-widget{--geoscene-widget-padding-x: 15px;--geoscene-widget-padding-y: var(--calcite-spacing-md);--geoscene-widget-padding: var(--geoscene-widget-padding-y) var(--geoscene-widget-padding-x);box-sizing:border-box;color:var(--calcite-color-text-2);background-color:var(--calcite-color-foreground-1);font-size:var(--calcite-font-size);line-height:var(--calcite-font-line-height-relative-tight)}.geoscene-widget *,.geoscene-widget :before,.geoscene-widget :after{box-sizing:inherit}.geoscene-widget.geoscene-widget--disabled>*{opacity:.4;pointer-events:none}.geoscene-widget.geoscene-widget--compact{--geoscene-widget-padding-y: 0;--geoscene-widget-padding-x: 0}.geoscene-widget__anchor{color:var(--calcite-color-text-2)}.geoscene-widget__anchor:hover{color:var(--calcite-color-text-3)}.geoscene-widget__anchor:hover,.geoscene-widget__anchor:focus{text-decoration:underline}.geoscene-widget__anchor--disabled{opacity:.4;pointer-events:none}.geoscene-widget__header{background-color:var(--calcite-color-foreground-1);flex:1 0 100%;justify-content:space-between;align-items:center;width:100%;min-height:48px;padding:12px 0 12px 15px;display:flex}.geoscene-widget__header .geoscene-widget__heading{width:calc(100% - 48px);text-align:initial;color:var(--calcite-color-text-1);align-items:center;margin:0;padding:0;display:flex}.geoscene-widget__header-button{appearance:none;cursor:pointer;color:var(--calcite-color-text-2);background-color:var(--calcite-color-foreground-1);border:none;flex:0 0 48px;justify-content:center;align-self:stretch;align-items:center;width:48px;padding:0;display:flex}.geoscene-widget__footer{background-color:var(--calcite-color-foreground-1);justify-content:center;align-items:center;width:100%;min-height:48px;display:flex}.geoscene-widget__footer-pagination{color:var(--calcite-color-text-2);justify-content:space-between;align-items:center;display:flex}.geoscene-widget__footer-pagination-previous-button,.geoscene-widget__footer-pagination-next-button{cursor:pointer;background-color:var(--calcite-color-foreground-1);border:0;margin:0 7px;padding:12px 15px;transition:background-color .125s ease-in-out}.geoscene-widget__footer-pagination-previous-button:hover,.geoscene-widget__footer-pagination-previous-button:focus,.geoscene-widget__footer-pagination-next-button:hover,.geoscene-widget__footer-pagination-next-button:focus{color:var(--calcite-color-text-1);background-color:var(--calcite-color-foreground-1)}.geoscene-menu{visibility:hidden;z-index:1;background-clip:padding;background-color:var(--calcite-color-foreground-1);background-clip:padding-box;width:100%;max-height:0;margin:2px 0 0;padding:0;font-size:var(--calcite-font-size);line-height:var(--calcite-spacing-xl);position:absolute;top:100%;left:0;overflow:hidden;box-shadow:0 1px 2px #0000004d}.geoscene-menu .geoscene-menu__header{color:var(--calcite-color-text-inverse);background-color:var(--calcite-color-inverse);padding:6px 12px}.geoscene-menu__list{margin:0;padding:0;list-style:none}.geoscene-menu__list-item{cursor:pointer;border-top:1px solid #adadad4d;border-left:3px solid #0000;padding:.8em 1em}.geoscene-menu__list-item [class^=geoscene-icon-],.geoscene-menu__list-item [class*=" geoscene-icon-"]{padding-right:2.8px}.geoscene-menu__list-item:first-child{border-top:none}.geoscene-menu__list-item--focus,.geoscene-menu__list-item:hover,.geoscene-menu__list-item:focus{background-color:var(--calcite-color-foreground-1)}.geoscene-menu__list-item:active{background-color:var(--calcite-color-foreground-current)}.geoscene-menu__list-item--active,.geoscene-menu__list-item--active:hover,.geoscene-menu__list-item--active:focus{background-color:var(--calcite-color-foreground-1);border-left-color:var(--calcite-color-brand)}.geoscene-widget__table{border-collapse:collapse;color:var(--calcite-color-text-1);border:none;width:100%;line-height:var(--calcite-font-line-height-relative-tight)}.geoscene-widget__table tr:nth-child(odd){background-color:var(--calcite-color-transparent)}.geoscene-widget__table tr:nth-child(2n){background-color:var(--calcite-color-transparent-press)}.geoscene-widget__table tr a{color:var(--calcite-color-text-2)}.geoscene-widget__table tr a:hover,.geoscene-widget__table tr a:focus{color:var(--calcite-color-text-1)}.geoscene-widget__table tr td,.geoscene-widget__table tr th{vertical-align:top;word-break:break-word;padding:.5em .7em;font-size:var(--calcite-font-size-sm);font-weight:var(--calcite-font-weight-regular)}.geoscene-widget__table tr th{text-align:left;border-right:3px solid #0000000d;width:50%}.geoscene-widget__table tr td{width:50%}.geoscene-input{color:var(--calcite-color-text-1);background-color:var(--calcite-color-foreground-1);border:1px solid #959595;font-size:var(--calcite-font-size)}.geoscene-input::-ms-clear{display:none}.geoscene-input::placeholder{opacity:1;color:var(--calcite-color-text-2)}.geoscene-input:placeholder-shown{text-overflow:ellipsis}.geoscene-input[type=text],.geoscene-input[type=password],.geoscene-input[type=number]{height:32px;padding:0 .5em}calcite-combobox.geoscene-input{border:none}.geoscene-widget__content--empty{text-align:center;color:var(--calcite-color-border-input);flex-flow:column wrap;align-items:center;padding:18px 22px;display:flex}.geoscene-widget__content--empty h1.geoscene-widget__heading,.geoscene-widget__content--empty h2.geoscene-widget__heading,.geoscene-widget__content--empty h3.geoscene-widget__heading,.geoscene-widget__content--empty h4.geoscene-widget__heading,.geoscene-widget__content--empty h5.geoscene-widget__heading{font-weight:var(--calcite-font-weight-regular)}.geoscene-widget__content-illustration--empty{width:128px;padding:1rem 0}.geoscene-widget__content-icon--empty{width:32px;padding:.5rem 0}.geoscene-select{appearance:none;cursor:pointer;color:var(--calcite-color-text-2);background:var(--calcite-color-foreground-1) url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='-8 -8 32 32' width='32' height='32'%3E%3Cpath d='M8 11.207l-4-4V5.793l4 4 4-4v1.414z' fill='%23adadad' fillrule='nonzero'/%3E%3C/svg%3E") 100% no-repeat;border:1px solid #959595;border-radius:0;width:100%;height:32px;margin:0;padding:0 .5em;font-family:inherit;font-size:.85em;display:block}.geoscene-select[disabled]{cursor:auto}.geoscene-select::-ms-expand{display:none}.geoscene-disabled a,.geoscene-disabled [role=menu],.geoscene-disabled [role=checkbox],.geoscene-disabled [class^=geoscene-icon-],.geoscene-disabled [class*=" geoscene-icon-"]{color:var(--calcite-color-text-3)}.keynav-mode .geoscene-widget:focus,.keynav-mode .geoscene-widget :focus{z-index:1;outline-offset:2px;outline:2px solid #adadad}.geoscene-widget__loader-animation{border:.15em solid #adadad4d;border-top-color:var(--calcite-color-border-input);border-radius:100%;width:1em;height:1em;font-size:var(--calcite-font-size-md);animation:1.25s linear infinite geoscene-rotate;display:block;transform:translateZ(0)}:dir(rtl) .geoscene-widget__table th{text-align:right;border-left:3px solid #0000000d;border-right:none}:dir(rtl) .geoscene-select{background-position:0}:dir(rtl) .geoscene-menu__list-item{border-left:none;border-right:3px solid #0000}:dir(rtl) .geoscene-menu__list-item [class^=geoscene-icon-],:dir(rtl) .geoscene-menu__list-item [class*=" geoscene-icon-"]{padding-left:2px;padding-right:0}:dir(rtl) .geoscene-menu__list-item--active{border-right-color:var(--calcite-color-brand)}.geoscene-icon-font-fallback-text{clip:rect(0 0 0 0);width:1px;height:1px;position:absolute;overflow:hidden}.geoscene-rotating{animation:1.25s linear infinite geoscene-rotate;transform:translateZ(0)}.geoscene-clearfix:before,.geoscene-clearfix:after{content:" ";display:table}.geoscene-clearfix:after{clear:both}.geoscene-interactive{cursor:pointer}.geoscene-hidden{display:none!important}.geoscene-invisible{visibility:hidden!important}.geoscene-offscreen{position:absolute;top:-999em;left:-999em}.geoscene-match-height{flex-direction:column;flex:auto;display:flex;overflow:hidden}:host{overflow:auto;width:var(--geoscene-legend-internal-width, 300px)}:host([card-style-layout="side-by-side"]){--geoscene-legend-internal-width: auto}`, y = v(c);
+class b extends g {
   constructor() {
-    super(...arguments), this.widget = d(this), this.viewModel = this.widget.viewModel, this.activeLayerInfos = this.widget.activeLayerInfos, this.autoDestroyDisabled = !1, this.basemapLegendVisible = this.widget.basemapLegendVisible, this.headingLevel = this.widget.headingLevel, this.hideLayersNotInCurrentView = this.widget.hideLayersNotInCurrentView, this.icon = this.widget.icon, this.label = this.widget.label, this.layerInfos = this.widget.layerInfos, this.legendStyle = this.widget.style, this.position = "bottom-left", this.respectLayerDefinitionExpression = this.widget.respectLayerDefinitionExpression, this.respectLayerVisibilityDisabled = this.widget.respectLayerVisibility, this.state = this.viewModel.state, this.geoscenePropertyChange = t()("state"), this.geosceneReady = r();
+    super(...arguments), this.messages = m({}), this.final = _("destroy"), this.viewModel = y(this), this._isCardStyle = !1, this.view = this.viewModel.view, this.icon = "legend", this.activeLayerInfos = this.viewModel.activeLayerInfos, this.basemapLegendVisible = this.viewModel.basemapLegendVisible, this.headingLevel = 3, this.hideLayersNotInCurrentView = this.viewModel.hideLayersNotInCurrentView, this.respectLayerDefinitionExpression = this.viewModel.respectLayerDefinitionExpression, this.layerInfos = this.viewModel.layerInfos, this.loading = this.viewModel.loading, this.legendStyle = "classic", this.autoDestroyDisabled = !1, this.label = this.messages?.componentLabel, this.state = this.viewModel.state, this.geoscenePropertyChange = u()("state"), this.geosceneReady = h();
   }
   static {
-    this.properties = { activeLayerInfos: 0, autoDestroyDisabled: 5, basemapLegendVisible: 5, headingLevel: 9, hideLayersNotInCurrentView: 5, icon: 1, label: 1, layerInfos: 0, legendStyle: 1, position: 1, referenceElement: 1, respectLayerDefinitionExpression: 5, respectLayerVisibilityDisabled: 5, state: 3 };
+    this.properties = { _isCardStyle: 16, view: 0, referenceElement: 1, position: 1, icon: 1, activeLayerInfos: 0, basemapLegendVisible: 5, headingLevel: 9, hideLayersNotInCurrentView: 5, respectLayerDefinitionExpression: 5, ignoreLayerVisibility: 5, respectLayerVisibilityDisabled: 5, layerInfos: 0, loading: 39, cardStyleLayout: 1, legendStyle: 1, autoDestroyDisabled: 5, messageOverrides: 0, label: 1, state: 3 };
   }
   static {
-    this.shadowRootOptions = a;
+    this.styles = w;
   }
-  static {
-    this.styles = l;
+  get ignoreLayerVisibility() {
+    return !this.viewModel.respectLayerVisibility;
+  }
+  set ignoreLayerVisibility(e) {
+    this.viewModel.respectLayerVisibility = !e;
+  }
+  get respectLayerVisibilityDisabled() {
+    return !this.viewModel.respectLayerVisibility;
+  }
+  set respectLayerVisibilityDisabled(e) {
+    this.viewModel.respectLayerVisibility = !e;
   }
   async destroy() {
     await this.manager.destroy();
   }
+  loaded() {
+    this.manager.onLifecycle(() => [
+      o(() => this.el.view, "resize", () => this.requestUpdate()),
+      o(() => this.activeLayerInfos, "change", () => this._refreshActiveLayerInfos(this.activeLayerInfos)),
+      s(() => [
+        this.cardStyleLayout,
+        this.legendStyle,
+        typeof this.legendStyle == "object" ? this.legendStyle.type : void 0,
+        typeof this.legendStyle == "object" ? this.legendStyle.layout : void 0
+      ], () => {
+        const e = this.legendStyle, i = typeof e == "object" ? e : { type: e };
+        this._isCardStyle = i.type === "card", this._isCardStyle ? (this.cardStyleLayout = this.cardStyleLayout || i.layout || "auto", this.cardStyleLayout === "auto" && this.el.closest("geoscene-expand") && (this.cardStyleLayout = "stack"), this.setAttribute("card-style-layout", this.cardStyleLayout)) : this.removeAttribute("card-style-layout");
+      }, { initial: !0 })
+    ]);
+  }
+  _refreshActiveLayerInfos(e) {
+    e.forEach((i) => {
+      this.final.removeHandles(`version_${i.layer.uid}`), this._renderOnActiveLayerInfoChange(i);
+    }), this.requestUpdate();
+  }
+  render() {
+    return r`<div class=${p(f(a.widget, { [a.panel]: !this._isCardStyle }))}>${this._isCardStyle && this.view ? r`<geoscene-legend-card-view .activeLayerInfos=${this.activeLayerInfos} .headingLevel=${this.headingLevel} .messages=${this.messages} .layout=${this.cardStyleLayout} .view=${this.view}></geoscene-legend-card-view>` : r`<geoscene-legend-classic-view .activeLayerInfos=${this.activeLayerInfos} .headingLevel=${this.headingLevel} .messages=${this.messages}></geoscene-legend-classic-view>`}</div>`;
+  }
+  _renderOnActiveLayerInfoChange(e) {
+    const i = s(() => e.version, () => this.requestUpdate());
+    this.final.addHandles(i, `version_${e.layer.uid}`);
+    const n = o(() => e.children, "change", () => e.children.forEach((t) => this._renderOnActiveLayerInfoChange(t)));
+    this.final.addHandles(n, `version_${e.layer.uid}`), e.children.forEach((t) => this._renderOnActiveLayerInfoChange(t));
+  }
 }
-e("geoscene-legend", h);
+l("geoscene-legend", b);
 export {
-  h as GeosceneLegend
+  b as GeosceneLegend
 };

package/dist/components/geoscene-legend/index.d.ts

@@ -1 +1,3 @@
+import "../geoscene-legend-card-view/index.js";
+import "../geoscene-legend-classic-view/index.js";
 export * from "./customElement.js";

package/dist/components/geoscene-legend/index.js

@@ -1 +1,3 @@
+import "../geoscene-legend-card-view/index.js";
+import "../geoscene-legend-classic-view/index.js";
 export * from "./customElement.js";

package/dist/components/geoscene-legend/support/svgGlobalState.d.ts

@@ -0,0 +1,7 @@
+export declare function nextPatternId(): number;
+export declare function resetPatternId(value?: number): void;
+export declare function nextLinearGradientId(): number;
+export declare function resetLinearGradientId(value?: number): void;
+export declare function nextBloomId(): number;
+export declare function resetBloomId(value?: number): void;
+export declare function resetSVGGlobalState(): void;