@esri/solutions-components 0.6.7 → 0.6.8

package/dist/types/components/layer-table/layer-table.d.ts

@@ -1,276 +1,298 @@
-/** @license
- * Copyright 2022 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/// <reference types="arcgis-js-api" />
-import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import LayerTable_T9n from "../../assets/t9n/layer-table/resources.json";
-import { IMapClick } from "../../utils/interfaces";
-export declare class LayerTable {
-  el: HTMLCrowdsourceManagerElement;
-  /**
-   * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
-   */
-  mapView: __esri.MapView;
-  /**
-   * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
-   */
-  zoomAndScrollToSelected: boolean;
-  /**
-   * boolean: When true a alert will be shown to indicate a problem or confirm the current action
-   */
-  _alertOpen: boolean;
-  /**
-   * boolean: When true a loading indicator will be shown in place of the layer table
-   */
-  _fetchingData: boolean;
-  /**
-   * esri/views/layers/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
-   */
-  _layer: __esri.FeatureLayer;
-  /**
-   * number[]: A list of indexes that are currently selected
-   */
-  _selectedIndexes: number[];
-  /**
-   * boolean: When true only selected records will be shown in the table
-   */
-  _showOnlySelected: boolean;
-  /**
-   * Contains the translations for this component.
-   * All UI strings should be defined here.
-   */
-  _translations: typeof LayerTable_T9n;
-  /**
-   * esri/widgets/FeatureTable: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html
-   */
-  protected FeatureTable: typeof import("esri/widgets/FeatureTable");
-  /**
-   * any: The function that the alerts action should execute
-   */
-  protected _alertActionFunction: any;
-  /**
-   * string: The alerts action text...will be displayed when _alertShowAction is True
-   */
-  protected _alertActionText: string;
-  /**
-   * string: main icon of the alert
-   */
-  protected _alertIcon: string;
-  /**
-   * "warning" | "danger": the kind of alert to display
-   */
-  protected _alertKind: "warning" | "danger";
-  /**
-   * boolean: When true a action link will be deisplayed
-   */
-  protected _alertShowAction: boolean;
-  /**
-   * string: main message of the alert
-   */
-  protected _alertMessage: string;
-  /**
-   * string: the alerts title
-   */
-  protected _alertTitle: string;
-  /**
-   * number[]: A list of all IDs for the current layer
-   */
-  protected _allIds: number[];
-  /**
-   * boolean: When false alerts will be shown to indicate that the layer must have editing enabled for edit actions
-   */
-  protected _editEnabled: boolean;
-  /**
-   * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
-   */
-  protected reactiveUtils: typeof import("esri/core/reactiveUtils");
-  /**
-   * HTMLCalciteCheckboxElement: Element to force selection of all records
-   */
-  protected _selectAllElement: HTMLCalciteCheckboxElement;
-  /**
-   * esri/widgets/FeatureTable: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html
-   */
-  protected _table: __esri.FeatureTable;
-  /**
-   * HTMLDivElement: Element to hold the FeatureTable
-   */
-  protected _tableNode: HTMLDivElement;
-  /**
-   * watch for changes in map view and get the first layer
-   */
-  mapViewWatchHandler(): Promise<void>;
-  /**
-   * watch for changes in layer view and verify if it has editing enabled
-   */
-  _layerWatchHandler(): Promise<void>;
-  /**
-   * Get the selected graphics
-   *
-   * @returns Promise that resolves when the operation is complete
-   */
-  getSelectedGraphics(): Promise<__esri.Graphic[]>;
-  /**
-   * Emitted on demand when a layer is selected
-   */
-  featureSelectionChange: EventEmitter<number[]>;
-  /**
-   * Scroll and zoom to the selected feature from the Features widget.
-   *
-   * @param evt CustomEvent the graphic for the current selection
-   */
-  selectionChanged(evt: CustomEvent): Promise<void>;
-  /**
-   * StencilJS: Called once just after the component is first connected to the DOM.
-   *
-   * @returns Promise when complete
-   */
-  componentWillLoad(): Promise<void>;
-  /**
-   * Renders the component.
-   */
-  render(): any;
-  /**
-   * Load esri javascript api modules
-   *
-   * @returns Promise resolving when function is done
-   *
-   * @protected
-   */
-  protected _initModules(): Promise<void>;
-  /**
-   * Gets a row of controls that can be used for various interactions with the table
-   *
-   * @param slot string optional slot to display the control within
-   *
-   * @returns The dom node that contains the controls
-   */
-  protected _getTableControlRow(slot?: string): VNode;
-  /**
-   * Store a reference to the table node after it's first created
-   * and initializes the FeatureTable
-   *
-   * @param node HTMLDivElement The node representing the DOM element that will contain the widget.
-   *
-   * @returns void
-   */
-  private onTableNodeCreate;
-  /**
-   * Initialize the FeatureTable
-   *
-   * @param node HTMLDivElement The node representing the DOM element that will contain the widget.
-   *
-   * @returns void
-   */
-  protected _getTable(node: HTMLDivElement): void;
-  /**
-   * Reset basic table props
-   *
-   * @returns void
-   */
-  protected _resetTable(): void;
-  /**
-   * Handle map click events to keep table and map click selection in sync
-   *
-   * @param evt IMapClick map click event details
-   *
-   * @returns void
-   */
-  protected _mapClicked(evt: IMapClick): Promise<void>;
-  /**
-   * Set the alertOpen member to false when the alert is closed
-   *
-   * @returns void
-   */
-  protected _alertClosed(): void;
-  /**
-   * Select or deselect all rows
-   *
-   * @returns void
-   */
-  protected _selectAll(): void;
-  /**
-   * Toggle the show only selected flag
-   *  When showOnly is true only the selected features will be shown in the table
-   *
-   * @returns void
-   */
-  protected _toggleShowSelected(): void;
-  /**
-   * Clears the selected indexes
-   *
-   * @returns void
-   */
-  protected _clearSelection(): void;
-  /**
-   * Show the filter options
-   *
-   * @returns void
-   */
-  protected _filter(): void;
-  /**
-   * Select all rows that are not currently selectd
-   *
-   * @returns void
-   */
-  protected _switchSelected(): void;
-  /**
-   * Export all selected rows as CSV
-   *
-   * @returns a promise that will resolve when the operation is complete
-   */
-  protected _exportToCSV(): Promise<void>;
-  /**
-   * Refreshes the table and maintains the curent scroll position
-   *
-   * @returns void
-   */
-  protected _refresh(): void;
-  /**
-   * Zoom to all selected features
-   *
-   * @returns a promise that will resolve when the operation is complete
-   */
-  protected _zoom(): void;
-  /**
-   * Delete all selected records or shows an alert if the layer does not have editing enabled
-   *
-   * @returns a promise that will resolve when the operation is complete
-   */
-  protected _delete(): void;
-  /**
-   * Get the graphics for all selected indexes
-   *
-   * @param ids the ids for the graphics to fetch
-   *
-   * @returns An array of selected graphics
-   */
-  protected _getGraphics(ids: number[]): Promise<__esri.Graphic[]>;
-  /**
-   * Handles layer selection change to show new table
-   *
-   * @param evt CustomEvent the id for the current layer
-   *
-   * @returns a promise that will resolve when the operation is complete
-   */
-  protected _layerSelectionChanged(evt: CustomEvent): Promise<void>;
-  /**
-   * Fetches the component's translations
-   *
-   * @returns Promise when complete
-   * @protected
-   */
-  protected _getTranslations(): Promise<void>;
-}
+/** @license
+ * Copyright 2022 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="arcgis-js-api" />
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import LayerTable_T9n from "../../assets/t9n/layer-table/resources.json";
+import { IMapClick } from "../../utils/interfaces";
+export declare class LayerTable {
+  el: HTMLCrowdsourceManagerElement;
+  /**
+   * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+   */
+  mapView: __esri.MapView;
+  /**
+   * boolean: when true the table will be sorted by objectid in descending order by default
+   */
+  showNewestFirst: boolean;
+  /**
+   * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
+   */
+  zoomAndScrollToSelected: boolean;
+  /**
+   * boolean: When true a alert will be shown to indicate a problem or confirm the current action
+   */
+  _alertOpen: boolean;
+  /**
+   * boolean: When true a loading indicator will be shown in place of the layer table
+   */
+  _fetchingData: boolean;
+  /**
+   * esri/views/layers/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+   */
+  _layer: __esri.FeatureLayer;
+  /**
+   * number[]: A list of indexes that are currently selected
+   */
+  _selectedIndexes: number[];
+  /**
+   * boolean: When true only selected records will be shown in the table
+   */
+  _showOnlySelected: boolean;
+  /**
+   * boolean: When true the user has defined a sort order that should override the default order
+   */
+  _sortActive: boolean;
+  /**
+   * Contains the translations for this component.
+   * All UI strings should be defined here.
+   */
+  _translations: typeof LayerTable_T9n;
+  /**
+   * esri/widgets/FeatureTable: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html
+   */
+  protected FeatureTable: typeof import("esri/widgets/FeatureTable");
+  /**
+   * any: The function that the alerts action should execute
+   */
+  protected _alertActionFunction: any;
+  /**
+   * string: The alerts action text...will be displayed when _alertShowAction is True
+   */
+  protected _alertActionText: string;
+  /**
+   * string: main icon of the alert
+   */
+  protected _alertIcon: string;
+  /**
+   * "warning" | "danger": the kind of alert to display
+   */
+  protected _alertKind: "warning" | "danger";
+  /**
+   * boolean: When true a action link will be deisplayed
+   */
+  protected _alertShowAction: boolean;
+  /**
+   * string: main message of the alert
+   */
+  protected _alertMessage: string;
+  /**
+   * string: the alerts title
+   */
+  protected _alertTitle: string;
+  /**
+   * number[]: A list of all IDs for the current layer
+   */
+  protected _allIds: number[];
+  /**
+   * boolean: When false alerts will be shown to indicate that the layer must have editing enabled for edit actions
+   */
+  protected _editEnabled: boolean;
+  /**
+   * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
+   */
+  protected reactiveUtils: typeof import("esri/core/reactiveUtils");
+  /**
+   * HTMLCalciteCheckboxElement: Element to force selection of all records
+   */
+  protected _selectAllElement: HTMLCalciteCheckboxElement;
+  /**
+   * esri/widgets/FeatureTable: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html
+   */
+  protected _table: __esri.FeatureTable;
+  /**
+   * HTMLDivElement: Element to hold the FeatureTable
+   */
+  protected _tableNode: HTMLDivElement;
+  /**
+   * bool: When true the table is being sorted
+   */
+  protected _tableSorting: boolean;
+  /**
+   * watch for changes in map view and get the first layer
+   */
+  mapViewWatchHandler(): Promise<void>;
+  /**
+   * watch for changes in layer view and verify if it has editing enabled
+   */
+  _layerWatchHandler(): Promise<void>;
+  /**
+   * When sortActive is false the user has not defined a sort and we should use the default sort
+   */
+  _sortActiveWatchHandler(): Promise<void>;
+  /**
+   * Get the selected graphics
+   *
+   * @returns Promise that resolves when the operation is complete
+   */
+  getSelectedGraphics(): Promise<__esri.Graphic[]>;
+  /**
+   * Emitted on demand when a layer is selected
+   */
+  featureSelectionChange: EventEmitter<number[]>;
+  /**
+   * Scroll and zoom to the selected feature from the Features widget.
+   *
+   * @param evt CustomEvent the graphic for the current selection
+   */
+  selectionChanged(evt: CustomEvent): Promise<void>;
+  /**
+   * StencilJS: Called once just after the component is first connected to the DOM.
+   *
+   * @returns Promise when complete
+   */
+  componentWillLoad(): Promise<void>;
+  /**
+   * Renders the component.
+   */
+  render(): any;
+  /**
+   * Load esri javascript api modules
+   *
+   * @returns Promise resolving when function is done
+   *
+   * @protected
+   */
+  protected _initModules(): Promise<void>;
+  /**
+   * Gets a row of controls that can be used for various interactions with the table
+   *
+   * @param slot string optional slot to display the control within
+   *
+   * @returns The dom node that contains the controls
+   */
+  protected _getTableControlRow(slot?: string): VNode;
+  /**
+   * Store a reference to the table node after it's first created
+   * and initializes the FeatureTable
+   *
+   * @param node HTMLDivElement The node representing the DOM element that will contain the widget.
+   *
+   * @returns void
+   */
+  private onTableNodeCreate;
+  /**
+   * Initialize the FeatureTable
+   *
+   * @param node HTMLDivElement The node representing the DOM element that will contain the widget.
+   *
+   * @returns void
+   */
+  protected _getTable(node: HTMLDivElement): Promise<void>;
+  /**
+   * Reset basic table props
+   *
+   * @returns void
+   */
+  protected _resetTable(): Promise<void>;
+  /**
+   * Sort the objectid field in descending order
+   *
+   * @returns void
+   */
+  protected _sortTable(): Promise<void>;
+  /**
+   * Handle map click events to keep table and map click selection in sync
+   *
+   * @param evt IMapClick map click event details
+   *
+   * @returns void
+   */
+  protected _mapClicked(evt: IMapClick): Promise<void>;
+  /**
+   * Set the alertOpen member to false when the alert is closed
+   *
+   * @returns void
+   */
+  protected _alertClosed(): void;
+  /**
+   * Select or deselect all rows
+   *
+   * @returns void
+   */
+  protected _selectAll(): void;
+  /**
+   * Toggle the show only selected flag
+   *  When showOnly is true only the selected features will be shown in the table
+   *
+   * @returns void
+   */
+  protected _toggleShowSelected(): void;
+  /**
+   * Clears the selected indexes
+   *
+   * @returns void
+   */
+  protected _clearSelection(): void;
+  /**
+   * Show the filter options
+   *
+   * @returns void
+   */
+  protected _filter(): void;
+  /**
+   * Select all rows that are not currently selectd
+   *
+   * @returns void
+   */
+  protected _switchSelected(): void;
+  /**
+   * Export all selected rows as CSV
+   *
+   * @returns a promise that will resolve when the operation is complete
+   */
+  protected _exportToCSV(): Promise<void>;
+  /**
+   * Refreshes the table and maintains the curent scroll position
+   *
+   * @returns void
+   */
+  protected _refresh(): void;
+  /**
+   * Zoom to all selected features
+   *
+   * @returns a promise that will resolve when the operation is complete
+   */
+  protected _zoom(): void;
+  /**
+   * Delete all selected records or shows an alert if the layer does not have editing enabled
+   *
+   * @returns a promise that will resolve when the operation is complete
+   */
+  protected _delete(): void;
+  /**
+   * Get the graphics for all selected indexes
+   *
+   * @param ids the ids for the graphics to fetch
+   *
+   * @returns An array of selected graphics
+   */
+  protected _getGraphics(ids: number[]): Promise<__esri.Graphic[]>;
+  /**
+   * Handles layer selection change to show new table
+   *
+   * @param evt CustomEvent the id for the current layer
+   *
+   * @returns a promise that will resolve when the operation is complete
+   */
+  protected _layerSelectionChanged(evt: CustomEvent): Promise<void>;
+  /**
+   * Fetches the component's translations
+   *
+   * @returns Promise when complete
+   * @protected
+   */
+  protected _getTranslations(): Promise<void>;
+}