GetDataAreaGridMetaData

Syntax

DataAreaGrid GetDataAreaGridMetaData(string mon, DataAreaGrid tArg)

Parameters

mon. Moniker of the Table visualizer.

tArg. Parameters of the Table visualizer that should be obtained.

Description

The GetDataAreaGridMetaData operation gets metadata of the Table visualizer.

Comments

The operation is used to work with the Table visualizer that displays data of analytical data area.

To execute the operation, in the mon field specify regular report instance moniker with the !DataArea!DataSources!source key!DataSourceSlices!slice key!Views!table key postfix. In the tArg field specify empty values or default values for the fields, which values should be obtained. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation returns requested metadata.

Example

Below is the example of getting various table metadata. The request contains table moniker and the list of obtained fields. The response contains requested metadata.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetDataAreaGridMetaData xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">GLCLGKOCBPDOFOAEENFEDILEMKNEILDEEJBICAEDMGPNBJLP!M!S!PIKDEKAPCBPDOFOAEIFJLGPOHDBHHIAFEFIDCDPHPDEAMFAID!DataArea!DataSources!1!DataSourceSlices!1!Views!6</mon>
<tArg xmlns="">
<adjustSettings>
  <mode>None</mode>
  <allowAdjust>false</allowAdjust>
  <maxRowsInCell>0</maxRowsInCell>
  <minVisibleDataColumns>0</minVisibleDataColumns>
  <leftHeaderMaxWidth>0</leftHeaderMaxWidth>
  <rowMaxHeight>0</rowMaxHeight>
  </adjustSettings>
  </tArg>
  </GetDataAreaGridMetaData>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDataAreaGridMetaDataResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<adjustSettings xmlns="">
  <mode>Simple</mode>
  <allowAdjust>1</allowAdjust>
  <maxRowsInCell>8</maxRowsInCell>
  <minVisibleDataColumns>1</minVisibleDataColumns>
  <leftHeaderMaxWidth>500</leftHeaderMaxWidth>
  <rowMaxHeight>50</rowMaxHeight>
  </adjustSettings>
  </GetDataAreaGridMetaDataResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetDataAreaGridMetaData" :
{
"mon" : "GLCLGKOCBPDOFOAEENFEDILEMKNEILDEEJBICAEDMGPNBJLP!M!S!PIKDEKAPCBPDOFOAEIFJLGPOHDBHHIAFEFIDCDPHPDEAMFAID!DataArea!DataSources!1!DataSourceSlices!1!Views!6",
"tArg" :
{
"adjustSettings" :
{
"mode" : "None",
"allowAdjust" : "false",
"maxRowsInCell" : "0",
"minVisibleDataColumns" : "0",
"leftHeaderMaxWidth" : "0",
"rowMaxHeight" : "0"
}
}
}
}

JSON response:

{
"GetDataAreaGridMetaDataResult" :
{
"adjustSettings" :
{
"mode" : "Simple",
"allowAdjust" : "1",
"maxRowsInCell" : "8",
"minVisibleDataColumns" : "1",
"leftHeaderMaxWidth" : "500",
"rowMaxHeight" : "50"
}
}
}
public static DataAreaGrid GetDataAreaGridMetaData(string moniker, uint sourceKey, uint sliceKey, uint viewKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetDataAreaGridMetaData()
{
tArg = new DataAreaGrid()
{
adjustSettings = new DataAreaGridAdjustSettings()
{
allowAdjust = new bool(),
leftHeaderMaxWidth = new int(),
maxRowsInCell = new int(),
minVisibleDataColumns = new int(),
mode = new EaxAdjustMode(),
rowMaxHeight = new int()
}
},
mon = moniker + "!DataArea!DataSources!" + sourceKey.ToString() + "!DataSourceSlices!" + sliceKey.ToString() + "!Views!" + viewKey.ToString()
};
// Get table metadata
var result = somClient.GetDataAreaGridMetaData(tGet);
return result;
}

See also:

Working with Regular Reports