SetDashboardMeta

Syntax

bool SetDashboardMeta(string mon, DashboardMetaArg tArg)

Parameters

mon. Moniker of opened information panel instance.

tArg. Operation execution parameters.

Description

The SetDashboardMeta operation changes information panel metadata.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance, and in the tArg.meta field specify updated metadata. In the current implementation the operation is used to change information panel visualization settings. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the logical true if the metadata was changed successfully.

Example

Below is the example of changing information panel visualization settings. The request contains moniker of opened information panel instance and visualization settings to be determined. The response contains whether changes were applied successfully.

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">
<SetDashboardMeta xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI</mon>
<tArg xmlns="">
<meta>
  <viewSettings>{"version":"2","isDataAndFieldsVisible":true,"isSettingsVisible":false,"zoom":0.75,"visibleArea":{"x":-200.17760487144778,"y":-93.49644790257105,"height":838,"width":771,"offsetX":560,"offsetY":48}}</viewSettings>
  </meta>
  </tArg>
  </SetDashboardMeta>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <SetDashboardMetaResult 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">1</SetDashboardMetaResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"SetDashboardMeta" :
{
"mon" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI",
"tArg" :
{
"meta" :
{
"viewSettings" : "{"version":"2","isDataAndFieldsVisible":true,"isSettingsVisible":false,"zoom":0.75,"visibleArea":{"x":-200.17760487144778,"y":-93.49644790257105,"height":838,"width":771,"offsetX":560,"offsetY":48}}"
}
}
}
}

JSON response:

{
"SetDashboardMetaResult" : "1"
}
public static bool SetDashboardMeta(string moniker, string newViewSettings)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tSet = new SetDashboardMeta()
{
tArg = new DashboardMetaArg()
{
meta = new DashboardMetaData()
{
viewSettings = newViewSettings
}
},
// Moniker of opened information panel instance
mon = moniker
};
// Change information about information panel
var result = somClient.SetDashboardMeta(tSet);
return result;
}

See also:

Working with Information Panel