Known types of plot geometries, usually used for different plot types.
Known deviation types of formplots.
Known types of plot geometries, usually used for different plot types.
The supported datatypes for plot properties.
Represents the value of a plot property. Timespans are stored as a number, which is the number of milliseconds.
Known types of plot tolerances, usually used for different plot types.
An enumeration to identify the entity to which a raw data item is attached.
Known segment types that indicate the supposed usage of a segment.
Known volume directions / planes
Escapes inspection plan entity names which would be invalid as a path element.
inspection plan entity name to escape.
Returns the database configuration from the PiWeb server.
Returns all defect plots that are bound to the plot extension element with databinding. You can change the databinding in PiWeb Designer. The defects are grouped by the measurement value they are associated to. Such a group or bundle is called DefectPlot. You can iterate either the defects or the plots by calling the getPlots method of the collection.
Returns all formplots that are bound to the plot extension element with databinding. You can change the databinding in PiWeb Designer.
Returns all inspection plan items that are bound to the plot extension element with databinding. You can change the databinding in PiWeb Designer.
Returns all measurements that are associated to the parts that are bound to the plot extension element with databinding. You can change the databinding and the measurement selection in PiWeb Designer.
Returns a list of all raw data entries that are bound to the plot extension via databinding. Since the raw data files are possibly quite large, they are not copied by the plot extension engine.
function getRawDataCollection() : RawDataCollection;
You can specify the entity from which you wish to get the raw data in the package definition.
Returns the raw data entities from which the plot extension fetches the raw data.
Returns a list of all volumes that are bound to the plot extension via databinding. Since the volumes are possibly very large, they are not copied by the plot extension engine.
function getVolumeCollection() : VolumeCollection;
You can specify the entity from which you wish to get the volume in the package definition.
Returns the raw data entities from which the plot extension fetches the volumes.
Returns an object from a path string - the opposite of format().
path to evaluate.
Resolves {pathSegments} to an absolute path.
If the right most argument isn't already absolute, arguments are prepended in right to left order, until an absolute path is found. If after using all paths still no absolute path is found, the path is considered relative to the root. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root.
string paths to join. Non-string arguments are ignored.
Sets a value indicating whether this plot needs to fetch defects.
Sets the raw data entities from which the plot extension fetches the raw data. By default, the plot fetches raw data from all entities, including measurement values. When the databinding of the plot extension element features a lot of characteristics and measurements, the raw data fetching can have a large performance impact.
Sets the raw data entities from which the plot extension fetches the volumes.
Generated using TypeDoc
Introduction
The
piweb.datainterface exposes methods to retrieve the inspection plan items, measurements, values and raw data that is bound to the plot extension element. Be aware that the data can change. Whenever this happens, the plot extension engine will emit thedataChangedevent.import * as piweb from 'piweb'; import data = piweb.data; piweb.events.on("dataChanged", loadData); function loadData() { const configuration = data.getConfiguration(); const inspectionPlan = data.getInspectionPlan(); ... }