PageGetAllDatasets

PageGetAllDatasets liefert die Zugriffsnummern aller Datensätze der Seite.

hvData = PageGetAllDatasets(hPage)

hvData = PageGetAllDatasets(hPage, bOnlyVisible)

hvData = PageGetAllDatasets(hPage, bOnlyVisible, ssType)

Returnwert

hvData ist ein Vektor mit den Zugriffsnummern aller Datensätze der Seite.

Parameter

hPage

hPage ist die Zugriffsnummer der mit PageCreate erzeugten Dokument-Seite.

bOnlyVisible

Falls bOnlyVisible TRUE (1) ist, werden nur die Datensätze zurück gegeben, die im Diagramm dargestellt werden. Siehe auch XYIsVisible oder XYZIsVisible. Defaultwert ist FALSE (0).

ssType

Falls ssType „OBJ_XYZDATASET“ ist, liefert die Funktion nur die Handle von 3D-Datensätzen. Falls ssType gleich „OBJ_XYDATASET“ ist, liefert die Funktion die Handle von 1D und 2D-Datensätzen. Wenn ein leerer String übergeben wird, liefert die Funktion bei Datensatztypen. Defaultwert ist „“ (alle Datensätze).

Beispiel

Example

Das folgende Beispiel erzeugt eine Liste aller im Dokument verwendeten Datenkanäle. Die Namen werden in einem Editorfenster angezeigt.

RegisterCommand("2D-Dataset", "_list_used_channel_names", "Create Used Channel Name List");
UserBar_Add("_list_used_channel_names");

def _list_used_channel_names()
{
   hDoc = AppGetActiveDocument();
   if (hDoc == 0) {
      return;
   }

   svChannel = "";
   hvPage = DocGetAllPages(hDoc, FALSE, FALSE);
   for (hPage in hvPage) {
      hvData = PageGetAllDatasets(hPage, FALSE);
      if (hvData[1] != 0) {
         for (hData in hvData) {
            svC = DS_GetChannelNames(hData);
            if (svC[1] != "") {
               svChannel = [svChannel, svC];
            }
         }
      }
   }
   svChannel = ST_set(svChannel);
   ssText = strcat(svChannel, "\n");
   hEdit = EdCreate();
   EdSetText(hEdit, "Used Channel Names:\n" + ssText);
   EdSetModify(hEdit, TRUE);
}

History

Version	Beschreibung
R2012.10	Dokumentation um 3. Parameter erweitert.
5.14.9	Zusätzlicher Parameter bOnlyVisible.

Siehe auch

Überblick Dokument-Seiten, PageGetSelectedDataLayer, GetParent, PageCreate, DocGetAllPages, PageGetAllLayers, LayerGetAllDatasets

_id-374603