@esri/solution-simple-types 4.1.2 → 5.0.1

package/dist/cjs/dashboard.d.ts

@@ -1,93 +1,93 @@
-/** @license
- * Copyright 2018 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.
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts a dashboard item to a template.
- *
- * @param itemTemplate Template for the dashboard item
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns templatized itemTemplate
- */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, templateDictionary: any): common.IItemTemplate;
-/**
- * Templatizes all itemIds and updates the dependency array
- *
- * @param itemTemplate Template for the dashboard item
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns The updated itemTemplate
- * @private
- */
-export declare function _extractDependencies(itemTemplate: common.IItemTemplate, templateDictionary: any): common.IItemTemplate;
-/**
- * Templatize datasource itemIds and update the dependency array
- *
- * @param obj A widget, selector, or urlParameter that contains a datasets collection
- * @param itemTemplate Template for the dashboard item
- * @param templateDictionary Hash of key details used for variable replacement
- * @private
- */
-export declare function _getDatasourceDependencies(obj: any, itemTemplate: common.IItemTemplate, templateDictionary: any): void;
-/**
- * Templatize field references for datasources and widgets.
- *
- * @param solutionTemplate The solution item template
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns The solutionTemplate with templatized field references
- */
-export declare function postProcessFieldReferences(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[]): common.IItemTemplate;
-/**
- * Add all dataset ids to the appropriate datasource info object so we can navigate any relative references
- *
- * @param objs Thes can be widgets, selectors, or urlParameters
- * @param datasourceInfos A list of objects that contain key details about the datasources from the application
- * @private
- */
-export declare function _updateDatasourceReferences(objs: any, datasourceInfos: common.IDatasourceInfo[]): void;
-/**
- * Templatize all datasets and/or events for the objects at the given path
- *
- * @param itemTemplate Template for the dashboard item
- * @param path A property path to an array of objects that could contain datasets or events
- * @param datasourceInfos A list of objects that contain key details about the datasources from the application
- * @private
- */
-export declare function _templatize(itemTemplate: common.IItemTemplate, path: string, datasourceInfos: common.IDatasourceInfo[]): void;
-/**
- * For any service dataset datasource templatize all field references
- *
- * @param objs A list of objects that can contain field references
- * @param datasourceInfos A list of objects that contain key details about the datasources from the application
- * @returns An updated list of objects with templatized field references
- * @private
- */
-export declare function _templatizeByDatasource(objs: any[], datasourceInfos: common.IDatasourceInfo[]): any;
-/**
- * Find the appropriate datasource info object from the datasourceInfo collection
- *
- * @param obj Can be a Dataset or an event
- * @param datasourceInfos A list of objects that contain key details about the datasources from the application
- * @returns The supporting datasource info for the given object
- * @private
- */
-export declare function _getDatasourceInfo(obj: any, datasourceInfos: common.IDatasourceInfo[]): any;
-/**
- * Verifies if the datasource info contains the given id and adds it if not
- *
- * @param ds The datasource info to add the reference to
- * @param id The id from dashboard object, commonly another widget
- * @private
- */
-export declare function _updateReferences(ds: common.IDatasourceInfo, id: string): void;
+/** @license
+ * Copyright 2018 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.
+ */
+import * as common from "@esri/solution-common";
+/**
+ * Converts a dashboard item to a template.
+ *
+ * @param itemTemplate Template for the dashboard item
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns templatized itemTemplate
+ */
+export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, templateDictionary: any): common.IItemTemplate;
+/**
+ * Templatizes all itemIds and updates the dependency array
+ *
+ * @param itemTemplate Template for the dashboard item
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns The updated itemTemplate
+ * @private
+ */
+export declare function _extractDependencies(itemTemplate: common.IItemTemplate, templateDictionary: any): common.IItemTemplate;
+/**
+ * Templatize datasource itemIds and update the dependency array
+ *
+ * @param obj A widget, selector, or urlParameter that contains a datasets collection
+ * @param itemTemplate Template for the dashboard item
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @private
+ */
+export declare function _getDatasourceDependencies(obj: any, itemTemplate: common.IItemTemplate, templateDictionary: any): void;
+/**
+ * Templatize field references for datasources and widgets.
+ *
+ * @param solutionTemplate The solution item template
+ * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
+ * @returns The solutionTemplate with templatized field references
+ */
+export declare function postProcessFieldReferences(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[]): common.IItemTemplate;
+/**
+ * Add all dataset ids to the appropriate datasource info object so we can navigate any relative references
+ *
+ * @param objs Thes can be widgets, selectors, or urlParameters
+ * @param datasourceInfos A list of objects that contain key details about the datasources from the application
+ * @private
+ */
+export declare function _updateDatasourceReferences(objs: any, datasourceInfos: common.IDatasourceInfo[]): void;
+/**
+ * Templatize all datasets and/or events for the objects at the given path
+ *
+ * @param itemTemplate Template for the dashboard item
+ * @param path A property path to an array of objects that could contain datasets or events
+ * @param datasourceInfos A list of objects that contain key details about the datasources from the application
+ * @private
+ */
+export declare function _templatize(itemTemplate: common.IItemTemplate, path: string, datasourceInfos: common.IDatasourceInfo[]): void;
+/**
+ * For any service dataset datasource templatize all field references
+ *
+ * @param objs A list of objects that can contain field references
+ * @param datasourceInfos A list of objects that contain key details about the datasources from the application
+ * @returns An updated list of objects with templatized field references
+ * @private
+ */
+export declare function _templatizeByDatasource(objs: any[], datasourceInfos: common.IDatasourceInfo[]): any;
+/**
+ * Find the appropriate datasource info object from the datasourceInfo collection
+ *
+ * @param obj Can be a Dataset or an event
+ * @param datasourceInfos A list of objects that contain key details about the datasources from the application
+ * @returns The supporting datasource info for the given object
+ * @private
+ */
+export declare function _getDatasourceInfo(obj: any, datasourceInfos: common.IDatasourceInfo[]): any;
+/**
+ * Verifies if the datasource info contains the given id and adds it if not
+ *
+ * @param ds The datasource info to add the reference to
+ * @param id The id from dashboard object, commonly another widget
+ * @private
+ */
+export declare function _updateReferences(ds: common.IDatasourceInfo, id: string): void;