IonAssetElementService

Extends

• ElementService

Members

Methods

Returns:

Returns:

Example:

const element = await elements.getElement(elementId);
const boundingSphere = Cesium.IonAssetElementService.getBoundingSphere(element);
if (Cesium.defined(boundingSphere)) {
  viewer.camera.flyToBoundingSphere(boundingSphere);
}

Returns:

Example:

const feature = viewer.scene.pick(movement.position);
const elementId = Cesium.IonAssetElementService.getElementId(feature);
if (Cesium.defined(elementId)) {
  const element = await elements.getElement(elementId);
}

Returns:

Throws:

• DeveloperError : options.propertyKeys must be a non-empty array of strings.

Example:

try {
  const result = await elements.aggregate({
    propertyKeys: ["Volume Aspect.Net Volume"],
    filter: { "IFC Class Name": "ifcwall" },
  });
  console.log(result.aggregations, result.total);
} catch (error) {
  console.error(error.statusCode, error.response);
};

Returns:

Returns:

Throws:

• DeveloperError : options.nodeKey must be a string.

Example:

try {
  const { nodes } = await elements.getElementTreeChildren();
  const { nodes: children } = await elements.getElementTreeChildren({
    nodeKey: nodes[0].key,
  });
  console.log(nodes);
} catch (error) {
  console.error(error.statusCode, error.response);
}

Returns:

Throws:

• DeveloperError : elementId must be a string.

Example:

try {
  const { path } = await elements.getElementTreeParents(elementId);
  console.log(path);
} catch (error) {
  console.error(error.statusCode, error.response);
}

Returns:

Throws:

• DeveloperError : options.top must be a positive integer.
• DeveloperError : options.continuationToken must be a string.

Example:

const page = await elements.listElements({
  filter: {
    $or: [{ "IFC Class Name": "ifcwall" }, { "IFC Class Name": "ifccolumn" }],
  },
});

Type Definitions

Properties:

Name	Type	Description
propertyKey	string	The qualified property key these statistics describe.
count	number	The number of elements that had a numeric value for this property key.
min	number | null	The minimum value across the matched elements, or null when there are no numeric values.
max	number | null	The maximum value across the matched elements, or null when there are no numeric values.
avg	number | null	The mean value across the matched elements, or null when there are no numeric values.
sum	number	The sum of values across the matched elements.

Properties:

Name	Type	Attributes	Description
id	string		The unique integer identifier of this element, as a decimal string, e.g. "3298534886898".
label	string	<optional>	The user-friendly label of this element, if any.
location	IonAssetElementService.ElementLocation	<optional>	The geographic location of this element, or undefined when the element has no location (e.g. conceptual elements, or assets with no geographic coordinate system).
properties	Object.<string, IonAssetElementService.ElementProperty>	<optional>	The properties of this element, keyed by property name. List results may omit properties; use IonAssetElementService#getElement to retrieve the element's details. Property names are kept verbatim, including any dotted namespaces (e.g. "Volume Aspect.Net Volume").

Properties:

Name	Type	Attributes	Description
items	Array.<IonAssetElementService.Element>		The elements on this page.
total	number | null		The total number of elements matching the query across all pages, or null when the total is unavailable.
continuationToken	string	<optional>	A token to pass as options.continuationToken to retrieve the next page, or undefined when there are no more results.

Properties:

Name	Type	Attributes	Description
value	*		The raw value of this property.
displayValue	string	<optional>	The human-readable, pre-formatted value, including any unit suffix (e.g. "0.6208 m³").
units	string | null	<optional>	The unit of value, or null or undefined when the property is unitless.

Properties:

Name	Type	Description
key	string	The opaque key of this node. Pass it as options.nodeKey to IonAssetElementService#getElementTreeChildren to list this node's children.
label	string	The user-friendly label of this node.
hasChildren	boolean	Whether this node has any children.
id	string	The integer instance id represented by this node, as a decimal string.
kind	"subject" | "model" | "category" | "element"	The kind of node.

Properties:

Name	Type	Description
kind	"subject" | "model" | "category" | "element"	The kind of path entry.
id	string	The integer instance id for this subject, model, category, or element, as a decimal string.