DashboardVisualizersDelete

Syntax

bool DashboardVisualizersDelete(string mon, DashboardVisualizer tArg)

Parameters

mon. Moniker for working with information panel visualizers.

tArg. Visualizer to be deleted.

Description

The DashboardVisualizersDelete operation deletes visualizer from information panel.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Visualizers postfix, and in the tArg.k field specify key of deleted visualizer. If the visualizer is on the slide, define the tArg.parentKey field. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the logical true if the visualizer is deleted successfully.

Example

Below is the example of deleting visualizer from information panel. The request contains moniker for working with visualizers and key of deleted visualizer. The response contains whether removal was successful.

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">
<DashboardVisualizersDelete xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Visualizers</mon>
<tArg xmlns="">
  <k>3</k>
  </tArg>
  </DashboardVisualizersDelete>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "DashboardVisualizersDelete" : 
  {
   "mon" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Visualizers",
   "tArg" : 
    {
     "k" : "3"
    }
  }
}

JSON response:

{
 "DashboardVisualizersDeleteResult" : "1"
}
public static bool DashboardVisualizersDelete(string moniker, uint visKey, ulong? parentVisKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tDel = new DashboardVisualizersDelete()
    {
        tArg = new DashboardVisualizer()
        {
            k = visKey,
            parentKey = parentVisKey
        },
        // Moniker for working with information panel visualizers
        mon = moniker + "!Visualizers"
    };
    // Delete visualizer
    var result = somClient.DashboardVisualizersDelete(tDel);
    return result;
}

See also:

Working with Information Panel