@vertigis/viewer-spec 56.24.0 → 56.25.0

package/messaging/registry/query-builder.d.ts

@@ -1,83 +1,83 @@
-import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource.js";
-import type { Command } from "../Command.js";
-import { CommandRegistry } from "../CommandRegistry.js";
-import type { Operation } from "../Operation.js";
-import { OperationRegistry } from "../OperationRegistry.js";
-import type { GeometryLike, GraphicsLike, LayersLike, ModelRef } from "../common.js";
-/**
- * A query that can be displayed in the query builder, or executed using the
- * `tasks.query` operation.
- */
-export interface Query {
-    /**
-     * The feature source to query. One of `source` or `layers` is required.
-     */
-    source?: FeatureSource;
-    /**
-     * Alias of `source`, to facilitate command chaining. If multiple layers are
-     * present, only the first will be used as the source. One of `source` or
-     * `layers` is required.
-     */
-    layers?: LayersLike;
-    /**
-     * The where clause to query by.
-     */
-    where?: string;
-    /**
-     * If specified, limits the results to ones that intersect the given
-     * geometry. If both `geometry` and `graphics` are specified, only
-     * `graphics` will be used.
-     */
-    geometry?: GeometryLike;
-    /**
-     * Alias of `geometry`, to facilitate command chaining. If both `geometry`
-     * and `graphics` are specified, only `graphics` will be used.
-     */
-    graphics?: GraphicsLike;
-}
-/**
- * Base arguments for commands/operations that target query builder components.
- */
-export interface QueryBuilderArgsBase {
-    /**
-     * The query builder component that will be targeted. If not specified, all
-     * active query builder components in the layout will be targeted.
-     */
-    queryBuilder?: ModelRef;
-}
-/**
- * Arguments for the "query-builder.set-query" command.
- */
-export interface SetQueryArgs extends QueryBuilderArgsBase, Query {
-}
-export declare class QueryBuilderCommands extends CommandRegistry {
-    protected readonly _prefix = "query-builder";
-    /**
-     * Sets the current query criteria in the query builder and also activates
-     * the component. Web only.
-     *
-     * @webOnly
-     */
-    get displayQuery(): Command<SetQueryArgs>;
-    /**
-     * Sets the current query criteria in the query builder. Web only.
-     *
-     * @webOnly
-     */
-    get setQuery(): Command<SetQueryArgs>;
-}
-/**
- * Arguments for the "query-builder.get-query" operation.
- */
-export interface GetQueryArgs extends Required<QueryBuilderArgsBase> {
-}
-export declare class QueryBuilderOperations extends OperationRegistry {
-    protected readonly _prefix = "query-builder";
-    /**
-     * Gets the currently visible query from the specified query builder
-     * component. Web only.
-     *
-     * @webOnly
-     */
-    get getQuery(): Operation<GetQueryArgs, Query | undefined>;
-}
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { GeometryLike, GraphicsLike, LayersLike, ModelRef } from "../common.js";
+/**
+ * A query that can be displayed in the query builder, or executed using the
+ * `tasks.query` operation.
+ */
+export interface Query {
+    /**
+     * The feature source to query. One of `source` or `layers` is required.
+     */
+    source?: FeatureSource;
+    /**
+     * Alias of `source`, to facilitate command chaining. If multiple layers are
+     * present, only the first will be used as the source. One of `source` or
+     * `layers` is required.
+     */
+    layers?: LayersLike;
+    /**
+     * The where clause to query by.
+     */
+    where?: string;
+    /**
+     * If specified, limits the results to ones that intersect the given
+     * geometry. If both `geometry` and `graphics` are specified, only
+     * `graphics` will be used.
+     */
+    geometry?: GeometryLike;
+    /**
+     * Alias of `geometry`, to facilitate command chaining. If both `geometry`
+     * and `graphics` are specified, only `graphics` will be used.
+     */
+    graphics?: GraphicsLike;
+}
+/**
+ * Base arguments for commands/operations that target query builder components.
+ */
+export interface QueryBuilderArgsBase {
+    /**
+     * The query builder component that will be targeted. If not specified, all
+     * active query builder components in the layout will be targeted.
+     */
+    queryBuilder?: ModelRef;
+}
+/**
+ * Arguments for the "query-builder.set-query" command.
+ */
+export interface SetQueryArgs extends QueryBuilderArgsBase, Query {
+}
+export declare class QueryBuilderCommands extends CommandRegistry {
+    protected readonly _prefix = "query-builder";
+    /**
+     * Sets the current query criteria in the query builder and also activates
+     * the component. Web only.
+     *
+     * @webOnly
+     */
+    get displayQuery(): Command<SetQueryArgs>;
+    /**
+     * Sets the current query criteria in the query builder. Web only.
+     *
+     * @webOnly
+     */
+    get setQuery(): Command<SetQueryArgs>;
+}
+/**
+ * Arguments for the "query-builder.get-query" operation.
+ */
+export interface GetQueryArgs extends Required<QueryBuilderArgsBase> {
+}
+export declare class QueryBuilderOperations extends OperationRegistry {
+    protected readonly _prefix = "query-builder";
+    /**
+     * Gets the currently visible query from the specified query builder
+     * component. Web only.
+     *
+     * @webOnly
+     */
+    get getQuery(): Operation<GetQueryArgs, Query | undefined>;
+}

package/messaging/registry/query-builder.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class QueryBuilderCommands extends e{constructor(){super(...arguments),this._prefix="query-builder"}get displayQuery(){return this._get("display-query")}get setQuery(){return this._get("set-query")}}export class QueryBuilderOperations extends r{constructor(){super(...arguments),this._prefix="query-builder"}get getQuery(){return this._get("get-query")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class QueryBuilderCommands extends e{_prefix="query-builder";get displayQuery(){return this._get("display-query")}get setQuery(){return this._get("set-query")}}export class QueryBuilderOperations extends r{_prefix="query-builder";get getQuery(){return this._get("get-query")}}

package/messaging/registry/region.d.ts

@@ -1,23 +1,23 @@
-import type { MeasurementSystem } from "../../app-config/common/RegionModelProperties.js";
-import type { Command } from "../Command.js";
-import { CommandRegistry } from "../CommandRegistry.js";
-import type { Event } from "../Event.js";
-import { EventRegistry } from "../EventRegistry.js";
-export declare class RegionCommands extends CommandRegistry {
-    protected readonly _prefix = "region";
-    /**
-     * Sets the current measurement system. Web only.
-     *
-     * @webOnly
-     */
-    get setMeasurementSystem(): Command<MeasurementSystem>;
-}
-export declare class RegionEvents extends EventRegistry {
-    protected readonly _prefix = "region";
-    /**
-     * Raised when the current measurement system is changed. Web only.
-     *
-     * @webOnly
-     */
-    get measurementSystemChanged(): Event<MeasurementSystem>;
-}
+import type { MeasurementSystem } from "../../app-config/common/RegionModelProperties.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+export declare class RegionCommands extends CommandRegistry {
+    protected readonly _prefix = "region";
+    /**
+     * Sets the current measurement system. Web only.
+     *
+     * @webOnly
+     */
+    get setMeasurementSystem(): Command<MeasurementSystem>;
+}
+export declare class RegionEvents extends EventRegistry {
+    protected readonly _prefix = "region";
+    /**
+     * Raised when the current measurement system is changed. Web only.
+     *
+     * @webOnly
+     */
+    get measurementSystemChanged(): Event<MeasurementSystem>;
+}

package/messaging/registry/region.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class RegionCommands extends e{constructor(){super(...arguments),this._prefix="region"}get setMeasurementSystem(){return this._get("set-measurement-system")}}export class RegionEvents extends t{constructor(){super(...arguments),this._prefix="region"}get measurementSystemChanged(){return this._get("measurement-system-changed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class RegionCommands extends e{_prefix="region";get setMeasurementSystem(){return this._get("set-measurement-system")}}export class RegionEvents extends t{_prefix="region";get measurementSystemChanged(){return this._get("measurement-system-changed")}}

package/messaging/registry/reports.d.ts

@@ -1,135 +1,135 @@
-import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
-import type { Command } from "../Command.js";
-import { CommandRegistry } from "../CommandRegistry.js";
-import type { Event } from "../Event.js";
-import { EventRegistry } from "../EventRegistry.js";
-import type { FeaturesLike } from "../common.js";
-/**
- * Represents a data source for VertiGIS Studio Reporting. A data source created
- * at report design time will be replaced by this data source at runtime.
- */
-export interface ReportDataSource {
-    /**
-     * The name is the name of the data source whose data you want to replace.
-     * The name must match the name of the data source in the report.
-     */
-    name: string;
-    /**
-     * The value is an object that defines the data to use in the report. The
-     * value is defined using the same schema as the data source in the report.
-     */
-    value: unknown;
-}
-/**
- * The arguments required by the reports.run command.
- */
-export interface RunReportArgs {
-    /**
-     * The ID of the report item.
-     */
-    id?: string;
-    /**
-     * The title of the report.
-     */
-    title?: string;
-    /**
-     * The portal item where the report is located.
-     */
-    portalItem?: PortalItemLike;
-    /**
-     * A unique ID to identify an instance of this report running.
-     */
-    instanceId?: string;
-    /**
-     * The features passed to the report.
-     */
-    features?: FeaturesLike;
-    /**
-     * Replace the data from one or more data sources at run time.
-     */
-    dataSources?: ReportDataSource | ReportDataSource[];
-}
-/**
- * Base for the Report Event Args interfaces.
- */
-export interface ReportEventArgsBase {
-    /**
-     * The ID of the report being run.
-     */
-    reportId: string;
-    /**
-     * A unique ID to track the running of this report.
-     */
-    instanceId: string;
-}
-/**
- * Arguments for the reports.report-error event.
- */
-export interface ReportErrorEventArgs extends ReportEventArgsBase {
-    /**
-     * The error message.
-     */
-    message: string;
-    /**
-     * The HTTP status code associated with the error, if it's a HTTP error.
-     */
-    errorCode?: number;
-}
-/**
- * Arguments for the reports.report-finished event.
- */
-export interface ReportFinishedEventArgs extends ReportEventArgsBase {
-    /**
-     * The URL to download the report at.
-     */
-    downloadUrl: string;
-}
-/**
- * Arguments for the reports.report-progress event.
- */
-export interface ReportProgressEventArgs extends ReportEventArgsBase {
-}
-/**
- * Arguments for the reports.report-started event.
- */
-export interface ReportStartedEventArgs extends ReportEventArgsBase {
-}
-export declare class ReportsCommands extends CommandRegistry {
-    protected readonly _prefix = "reports";
-    /**
-     * Run a report on the given features. The report URL and feature IDs are
-     * provided by the viewer. Web only.
-     *
-     * @webOnly
-     */
-    get run(): Command<RunReportArgs>;
-}
-export declare class ReportEvents extends EventRegistry {
-    protected readonly _prefix = "reports";
-    /**
-     * Raised when a report has started running. Web only.
-     *
-     * @webOnly
-     */
-    get reportStarted(): Event<ReportStartedEventArgs>;
-    /**
-     * Raised while a report is running to provide updates on its status. Web
-     * only.
-     *
-     * @webOnly
-     */
-    get reportProgress(): Event<ReportProgressEventArgs>;
-    /**
-     * Raised when a report has finished running. Event arguments include the
-     * report download URL. Web only.
-     *
-     * @webOnly
-     */
-    get reportFinished(): Event<ReportFinishedEventArgs>;
-    /**
-     * Raised when an error occurs with running a report. Web only.
-     *
-     * @webOnly
-     */
-    get reportError(): Event<ReportErrorEventArgs>;
-}
+import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { FeaturesLike } from "../common.js";
+/**
+ * Represents a data source for VertiGIS Studio Reporting. A data source created
+ * at report design time will be replaced by this data source at runtime.
+ */
+export interface ReportDataSource {
+    /**
+     * The name is the name of the data source whose data you want to replace.
+     * The name must match the name of the data source in the report.
+     */
+    name: string;
+    /**
+     * The value is an object that defines the data to use in the report. The
+     * value is defined using the same schema as the data source in the report.
+     */
+    value: unknown;
+}
+/**
+ * The arguments required by the reports.run command.
+ */
+export interface RunReportArgs {
+    /**
+     * The ID of the report item.
+     */
+    id?: string;
+    /**
+     * The title of the report.
+     */
+    title?: string;
+    /**
+     * The portal item where the report is located.
+     */
+    portalItem?: PortalItemLike;
+    /**
+     * A unique ID to identify an instance of this report running.
+     */
+    instanceId?: string;
+    /**
+     * The features passed to the report.
+     */
+    features?: FeaturesLike;
+    /**
+     * Replace the data from one or more data sources at run time.
+     */
+    dataSources?: ReportDataSource | ReportDataSource[];
+}
+/**
+ * Base for the Report Event Args interfaces.
+ */
+export interface ReportEventArgsBase {
+    /**
+     * The ID of the report being run.
+     */
+    reportId: string;
+    /**
+     * A unique ID to track the running of this report.
+     */
+    instanceId: string;
+}
+/**
+ * Arguments for the reports.report-error event.
+ */
+export interface ReportErrorEventArgs extends ReportEventArgsBase {
+    /**
+     * The error message.
+     */
+    message: string;
+    /**
+     * The HTTP status code associated with the error, if it's a HTTP error.
+     */
+    errorCode?: number;
+}
+/**
+ * Arguments for the reports.report-finished event.
+ */
+export interface ReportFinishedEventArgs extends ReportEventArgsBase {
+    /**
+     * The URL to download the report at.
+     */
+    downloadUrl: string;
+}
+/**
+ * Arguments for the reports.report-progress event.
+ */
+export interface ReportProgressEventArgs extends ReportEventArgsBase {
+}
+/**
+ * Arguments for the reports.report-started event.
+ */
+export interface ReportStartedEventArgs extends ReportEventArgsBase {
+}
+export declare class ReportsCommands extends CommandRegistry {
+    protected readonly _prefix = "reports";
+    /**
+     * Run a report on the given features. The report URL and feature IDs are
+     * provided by the viewer. Web only.
+     *
+     * @webOnly
+     */
+    get run(): Command<RunReportArgs>;
+}
+export declare class ReportEvents extends EventRegistry {
+    protected readonly _prefix = "reports";
+    /**
+     * Raised when a report has started running. Web only.
+     *
+     * @webOnly
+     */
+    get reportStarted(): Event<ReportStartedEventArgs>;
+    /**
+     * Raised while a report is running to provide updates on its status. Web
+     * only.
+     *
+     * @webOnly
+     */
+    get reportProgress(): Event<ReportProgressEventArgs>;
+    /**
+     * Raised when a report has finished running. Event arguments include the
+     * report download URL. Web only.
+     *
+     * @webOnly
+     */
+    get reportFinished(): Event<ReportFinishedEventArgs>;
+    /**
+     * Raised when an error occurs with running a report. Web only.
+     *
+     * @webOnly
+     */
+    get reportError(): Event<ReportErrorEventArgs>;
+}

package/messaging/registry/reports.js

@@ -1 +1 @@
-import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class ReportsCommands extends r{constructor(){super(...arguments),this._prefix="reports"}get run(){return this._get("run")}}export class ReportEvents extends t{constructor(){super(...arguments),this._prefix="reports"}get reportStarted(){return this._get("report-started")}get reportProgress(){return this._get("report-progress")}get reportFinished(){return this._get("report-finished")}get reportError(){return this._get("report-error")}}
+import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";export class ReportsCommands extends r{_prefix="reports";get run(){return this._get("run")}}export class ReportEvents extends e{_prefix="reports";get reportStarted(){return this._get("report-started")}get reportProgress(){return this._get("report-progress")}get reportFinished(){return this._get("report-finished")}get reportError(){return this._get("report-error")}}