@itwin/presentation-components
Version:
React components based on iTwin.js Presentation library
148 lines • 6.87 kB
JavaScript
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module FavoriteProperties
*/
var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
if (value !== null && value !== void 0) {
if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
var dispose, inner;
if (async) {
if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
dispose = value[Symbol.asyncDispose];
}
if (dispose === void 0) {
if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
dispose = value[Symbol.dispose];
if (async) inner = dispose;
}
if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
env.stack.push({ value: value, dispose: dispose, async: async });
}
else if (async) {
env.stack.push({ async: true });
}
return value;
};
var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
return function (env) {
function fail(e) {
env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
env.hasError = true;
}
var r, s = 0;
function next() {
while (r = env.stack.pop()) {
try {
if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
if (r.dispose) {
var result = r.dispose.call(r.value);
if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
}
else s |= 1;
}
catch (e) {
fail(e);
}
}
if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
if (env.hasError) throw env.error;
}
return next();
};
})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
var e = new Error(message);
return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
});
import { KeySet } from "@itwin/presentation-common";
import { createECSqlQueryExecutor } from "@itwin/presentation-core-interop";
import { Presentation } from "@itwin/presentation-frontend";
import { computeSelection } from "@itwin/unified-selection";
import { mapPresentationFrontendSelectionScopeToUnifiedSelectionScope } from "../common/Utils.js";
import { PresentationPropertyDataProvider } from "../propertygrid/DataProvider.js";
import { getFavoritesCategory } from "./Utils.js";
/**
* Presentation Rules-driven element favorite properties data provider implementation.
* @public
*/
export class FavoritePropertiesDataProvider {
_customRuleset;
_getActiveScope;
/**
* Should fields with no values be included in the property list. No value means:
* - For *primitive* fields: `null`, `undefined`, `""` (empty string)
* - For *array* fields: `[]` (empty array)
* - For *struct* fields: `{}` (object with no members)
*/
includeFieldsWithNoValues;
/**
* Should fields with composite values be included in the property list.
* Fields with composite values:
* - *array* fields.
* - *struct* fields.
*/
includeFieldsWithCompositeValues;
/** Constructor. */
constructor(props) {
this.includeFieldsWithNoValues = true;
this.includeFieldsWithCompositeValues = true;
this._customRuleset = /* c8 ignore next */ props?.ruleset;
/* c8 ignore start */
this._getActiveScope =
// eslint-disable-next-line @typescript-eslint/no-deprecated
props?.activeScopeProvider ?? (() => mapPresentationFrontendSelectionScopeToUnifiedSelectionScope(Presentation.selection.scopes.activeScope));
/* c8 ignore end */
}
/**
* Returns PropertyData for the specified elements.
* PropertyData only contains a single category for favorite properties (if there are any).
*/
async getData(imodel, elementIds) {
if (elementIds instanceof KeySet) {
const env_1 = { stack: [], error: void 0, hasError: false };
try {
const propertyDataProvider = __addDisposableResource(env_1, this.createPropertyDataProvider(imodel, this._customRuleset), false);
propertyDataProvider.keys = elementIds;
// eslint-disable-next-line @typescript-eslint/no-deprecated
propertyDataProvider.includeFieldsWithNoValues = this.includeFieldsWithNoValues;
// eslint-disable-next-line @typescript-eslint/no-deprecated
propertyDataProvider.includeFieldsWithCompositeValues = this.includeFieldsWithCompositeValues;
const propertyData = await propertyDataProvider.getData();
// leave only favorite properties
const favoritesCategory = getFavoritesCategory();
propertyData.categories = propertyData.categories.filter((c) => c.name === favoritesCategory.name);
propertyData.records = propertyData.records.hasOwnProperty(favoritesCategory.name)
? { [favoritesCategory.name]: propertyData.records[favoritesCategory.name] }
: {};
return propertyData;
}
catch (e_1) {
env_1.error = e_1;
env_1.hasError = true;
}
finally {
__disposeResources(env_1);
}
}
const iter = computeSelection({
queryExecutor: createECSqlQueryExecutor(imodel),
scope: this._getActiveScope(),
elementIds,
});
const keys = new KeySet();
for await (const key of iter) {
keys.add(key);
}
return this.getData(imodel, keys);
}
/* c8 ignore start */
createPropertyDataProvider(imodel, ruleset) {
const provider = new PresentationPropertyDataProvider({ imodel, ruleset });
provider.isNestedPropertyCategoryGroupingEnabled = false;
return provider;
}
}
//# sourceMappingURL=DataProvider.js.map