@vertigis/viewer-spec 42.10.0

package/messaging/registry/reports.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class ReportsCommands extends CommandRegistry{get run(){return this._messages.command("reports.run")}}export class ReportEvents extends EventRegistry{get reportStarted(){return this._messages.event("reports.report-started")}get reportProgress(){return this._messages.event("reports.report-progress")}get reportFinished(){return this._messages.event("reports.report-finished")}get reportError(){return this._messages.event("reports.report-error")}}

package/messaging/registry/results.d.ts

@@ -0,0 +1,454 @@
+import type Graphic from "@arcgis/core/Graphic";
+import type Layer from "@arcgis/core/layers/Layer";
+import type Sublayer from "@arcgis/core/layers/support/Sublayer";
+import type Symbol from "@arcgis/core/symbols/Symbol";
+import type { Attachment } from "@vertigis/arcgis-extensions/data/Attachment";
+import type { Feature } from "@vertigis/arcgis-extensions/data/Feature";
+import type { FeatureSettingsProperties } from "@vertigis/arcgis-extensions/data/FeatureSettings";
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
+import type { SchemaProperties } from "@vertigis/arcgis-extensions/data/Schema";
+import type { FromCsvOptions, FromShapefileOptions, FromXLSXOptions, ToCsvOptions, ToShapefileOptions, ToXLSXOptions } from "@vertigis/arcgis-extensions/data/convert";
+import type { QueryOptions } from "@vertigis/arcgis-extensions/tasks/query/QueryOptions";
+import type { CardSize, ViewMode } from "../../app-config/web/ResultsModelProperties.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Blob, Features, FeaturesLike, GraphicsLike, HasFeatures, MapsLike, ModelRef } from "../common.js";
+import type { VisualElement } from "../mobile.js";
+/**
+ * Arguments for various commands that affect a result component's features.
+ */
+export interface UpdateResultsFeaturesArgs extends HasFeatures {
+    /**
+     * The result component to update, referenced by results model or its ID.
+     *
+     * @webOnly
+     */
+    results: ModelRef;
+}
+/**
+ * Arguments for the "results.convert-to-csv" operation.
+ */
+export interface ToCsvConversionArgs extends ToCsvOptions {
+    /**
+     * The feature(s) to convert.
+     */
+    features: Features;
+}
+/**
+ * Arguments for the "results.from-csv" operation.
+ */
+export interface FromCsvConversionArgs extends FromCsvOptions {
+    /**
+     * The blob(s) that contains the csv file.
+     */
+    blobs: Blob[];
+}
+/**
+ * Arguments for the "results.convert-to-xlsx" operation.
+ */
+export interface ToXLSXConversionArgs extends ToXLSXOptions {
+    /**
+     * The feature(s) to convert.
+     */
+    features: Features;
+}
+/**
+ * Arguments for the "results.from-xlsx" operation.
+ */
+export interface FromXLSXConversionArgs extends FromXLSXOptions {
+    /**
+     * The blob(s) that contains the xlsx file.
+     */
+    blobs: Blob[];
+}
+/**
+ * Arguments for the "results.convert-to-shapefile" operation.
+ */
+export interface ToShapefileConversionArgs extends ToShapefileOptions {
+    /**
+     * The feature(s) to convert.
+     */
+    features: Features;
+}
+/**
+ * Arguments for the "results.from-shapefile" operation.
+ */
+export interface FromShapefileConversionArgs extends FromShapefileOptions {
+    /**
+     * The blob(s) that contains the Shapefile file.
+     */
+    blobs: Blob[];
+}
+/**
+ * Arguments for the "results.convert-to-layers" operation.
+ */
+export interface LayerConversionArgs {
+    /**
+     * Optionally a symbol to be used for point geometries.
+     */
+    pointSymbol?: Symbol;
+    /**
+     * Optionally a symbol to be used for multipoint geometries.
+     */
+    multipointSymbol?: Symbol;
+    /**
+     * Optionally a symbol to be used for polyline geometries.
+     */
+    polylineSymbol?: Symbol;
+    /**
+     * Optionally a symbol to be used for polygon geometries.
+     */
+    polygonSymbol?: Symbol;
+    /**
+     * Optionally a symbol to be used for mesh geometries.
+     */
+    meshSymbol?: Symbol;
+    /**
+     * The feature(s) to convert.
+     */
+    features: Features;
+}
+/**
+ * Result of various operations that convert features into a downloadable file.
+ */
+export interface ConversionResult {
+    /**
+     * The result of the conversion in the specified form.
+     */
+    result: Blob;
+    /**
+     * A file name representation for the conversion.
+     */
+    name: string;
+}
+/**
+ * Arguments for the "results.from-graphics" operation.
+ */
+export interface FromGraphicsArgs {
+    /**
+     * A selection of graphics to be converted to features.
+     */
+    graphics: GraphicsLike;
+    /**
+     * The layer the graphics originate from, or the ID of that layer. Used as
+     * the source for created features.
+     */
+    layer?: Layer | string;
+    /**
+     * The sublayer the graphics originate from, or the ID of that sublayer.
+     * Used as the source for created features. Will not be used unless layer
+     * parameter is also provided.
+     */
+    sublayer?: Sublayer | number;
+    /**
+     * The maps to search for the given layer.
+     */
+    maps?: MapsLike;
+    /**
+     * FeatureSettings to use for feature metadata if the layer is not provided
+     * or can't be found.
+     */
+    featureSettings?: FeatureSettingsProperties;
+    /**
+     * The schema to be associated with the returned features. This property is
+     * only necessary when no layer nor sublayer are present.
+     */
+    schema?: SchemaProperties;
+    /**
+     * The feature source title to use if no layer or sublayer is associated
+     * with the features.
+     */
+    title?: string;
+    /**
+     * The feature source ID to use if the results are associated with a
+     * workflow.
+     */
+    workflowItemId?: string;
+}
+/**
+ * Arguments for the "results.open-attachment" command.
+ */
+export interface OpenAttachmentArgs {
+    /**
+     * The index of the photo to start at.
+     */
+    startIndex: number;
+    /**
+     * The attachment to open.
+     */
+    attachments: Attachment[];
+    /**
+     * The sender UI element to use as an anchor point for animation when
+     * opening the attachment.
+     */
+    sender: VisualElement;
+}
+/**
+ * Arguments for the "results.filter" operation.
+ */
+export interface FilterResultsArgs {
+    /**
+     * Features or Graphics to filter.
+     */
+    features: FeaturesLike | GraphicsLike;
+    /**
+     * An SQL 'where' clause used to filter down a set of results.
+     */
+    where?: string;
+    /**
+     * The source of the Results. This is only necessary if Graphics are passed
+     * into the filter operation.
+     */
+    source?: FeatureSource;
+    /**
+     * Additional query options with which to filter the results.
+     */
+    options?: QueryOptions;
+}
+/**
+ * Arguments for the "results.set-list-view-mode" command.
+ */
+export interface SetListViewModeArgs {
+    /**
+     * The view mode to activate on the results list component.
+     *
+     * @webOnly
+     */
+    viewMode: ViewMode;
+    /**
+     * The result component to update, referenced by results model or its ID.
+     *
+     * @webOnly
+     */
+    results?: ModelRef;
+}
+/**
+ * Arguments for the "results.set-list-card-size" command.
+ */
+export interface SetListCardSizeArgs {
+    /**
+     * The card size to set on the results list component.
+     *
+     * @webOnly
+     */
+    cardSize: CardSize;
+    /**
+     * The result component to update, referenced by results model or its ID.
+     *
+     * @webOnly
+     */
+    results?: ModelRef;
+}
+/**
+ * Arguments for various commands that manipulate the current set of shown
+ * results.
+ */
+export declare type ShowResultsArgs = Features | (UpdateResultsFeaturesArgs & {
+    /**
+     * Whether to activate the component showing the results of the
+     * operation. False by default.
+     *
+     * @mobileOnly
+     */
+    activate?: boolean;
+});
+/**
+ * Arguments for the "results.set-display-components" command.
+ */
+export interface SetDisplayComponentArgs {
+    /**
+     * Sets the current selector for the results components to display results
+     * using `results.display`. Additionally, any components that do not match
+     * the current selector are deactivated.
+     */
+    selector: string;
+    /**
+     * The result component to update, referenced by results model or its ID.
+     *
+     * @webOnly
+     */
+    results?: ModelRef;
+}
+export declare class ResultsCommands extends CommandRegistry {
+    /**
+     * Presents features to the user within any components that can display
+     * features, such as a feature list, feature table, or feature details
+     * component. The argument is the features to display, or an object
+     * specifying both features and the target results component to update (Web
+     * only).
+     */
+    get display(): Command<Features | UpdateResultsFeaturesArgs>;
+    /**
+     * Sets the current selector for the results components to display results
+     * using `results.display`. Additionally, any components that do not match
+     * the current selector are deactivated.
+     *
+     * @webOnly
+     */
+    get setDisplayComponents(): Command<string | SetDisplayComponentArgs>;
+    /**
+     * Presents feature details to the user within the feature-details
+     * component. The argument is the feature(s) to display, or an object
+     * specifying both features and the target results component to update (Web
+     * only).
+     */
+    get displayDetails(): Command<Features | UpdateResultsFeaturesArgs>;
+    /**
+     * Presents a feature summary to the user within the feature-summary
+     * component. The argument is the feature(s) to display, or an object
+     * specifying both features and the target results component to update (Web
+     * only).
+     *
+     * @webOnly
+     */
+    get displaySummary(): Command<Features | UpdateResultsFeaturesArgs>;
+    /**
+     * Presents new feature details to the user within the feature-details
+     * component. If the feature-details component is contained within a panel,
+     * a 'back' button will be provided to navigate to the previous content;
+     * otherwise, the content of the feature-details component will be replaced.
+     */
+    get displayNewDetails(): Command<Features | UpdateResultsFeaturesArgs>;
+    /**
+     * Adds features to a currently shown set of features.
+     */
+    get add(): Command<ShowResultsArgs>;
+    /**
+     * Removes features from the existing results that are not present in the
+     * given list of features.
+     */
+    get intersect(): Command<ShowResultsArgs>;
+    /**
+     * Removes features from a currently shown set of features.
+     */
+    get remove(): Command<ShowResultsArgs>;
+    /**
+     * Clear features from results list, results table, and results details. If
+     * a component model or model ID is given, then only the specified component
+     * is cleared (Web only).
+     */
+    get clear(): Command<ModelRef | void>;
+    /**
+     * Clears the feature details so that no feature data is shown.
+     *
+     * @mobileOnly
+     */
+    get clearDetails(): Command;
+    /**
+     * Deactivates the feature details component that is displaying the given
+     * feature.
+     *
+     * @mobileOnly
+     */
+    get hideDetails(): Command<Feature[] | Feature>;
+    /**
+     * Opens an attachment and displays it.
+     *
+     * @mobileOnly
+     */
+    get openAttachment(): Command<OpenAttachmentArgs>;
+    /**
+     * Refreshes one or more features in the results list.
+     *
+     * @mobileOnly
+     */
+    get refresh(): Command<Features>;
+    /**
+     * Sets the view mode for a particular results list component, or globally
+     * for all results list components.
+     *
+     * @webOnly
+     */
+    get setListViewMode(): Command<ViewMode | SetListViewModeArgs>;
+    /**
+     * Sets the card size for a particular results list component, or globally
+     * for all results list components.
+     *
+     * @webOnly
+     */
+    get setListCardSize(): Command<CardSize | SetListCardSizeArgs>;
+}
+export declare class ResultsEvents extends EventRegistry {
+    /**
+     * Raised when results are displayed.
+     *
+     * @mobileOnly
+     */
+    get displayed(): Event<Features>;
+}
+export declare class ResultsOperations extends OperationRegistry {
+    /**
+     * Converts the provided Feature(s) to a CSV file grouped by feature source.
+     * If there are multiple sources the CSV(s) will be bundled in a zip file.
+     *
+     * @webOnly
+     */
+    get convertToCsv(): Operation<ToCsvConversionArgs | Features, ConversionResult>;
+    /**
+     * Converts the provided Feature(s) to a XLSX file grouped by feature
+     * source. If there are multiple sources the XLSX(s) will be bundled in a
+     * zip file.
+     *
+     * @webOnly
+     */
+    get convertToXlsx(): Operation<ToXLSXConversionArgs | Features, ConversionResult>;
+    /**
+     * Converts the provided Feature(s) to a Shapefile grouped by feature
+     * source. If there are multiple sources the Shapefile(s) will be bundled in
+     * a zip file.
+     *
+     * @webOnly
+     */
+    get convertToShapefile(): Operation<ToShapefileConversionArgs | Features, ConversionResult>;
+    /**
+     * Creates layer(s) from the specified features.
+     *
+     * @webOnly
+     */
+    get convertToLayers(): Operation<LayerConversionArgs | Features, Layer[]>;
+    /**
+     * Convert the specified csv blob to Features.
+     *
+     * @webOnly
+     */
+    get fromCsv(): Operation<FromCsvConversionArgs | Blob | Blob[], Features>;
+    /**
+     * Convert the specified Shapefile blob to Features.
+     *
+     * @webOnly
+     */
+    get fromShapefile(): Operation<FromShapefileConversionArgs | Blob | Blob[], Features>;
+    /**
+     * Convert the specified xlsx blob to Features.
+     *
+     * @webOnly
+     */
+    get fromXlsx(): Operation<FromXLSXConversionArgs | Blob | Blob[], Features>;
+    /**
+     * Converts provided GraphicsLike to Geocortex Features using any available
+     * metadata.
+     */
+    get fromGraphics(): Operation<FromGraphicsArgs, Features>;
+    /**
+     * Converts Geocortex Features to Esri graphics.
+     */
+    get toGraphics(): Operation<Features, Graphic[]>;
+    /**
+     * Returns the current set of features from a specific results component if
+     * a model or model ID is specified, otherwise from all results components.
+     *
+     * @webOnly
+     */
+    get getFeatures(): Operation<ModelRef | void, Features>;
+    /**
+     * Filters down a set of results using an SQL 'where' clause and/or an
+     * intersecting geometry.
+     *
+     * @webOnly
+     */
+    get filter(): Operation<FilterResultsArgs, Features>;
+}