graphprototype.update

Beschrijving

object graphprototype.update(object/array graphPrototypes)

Deze methode maakt het mogelijk om bestaande grafiek-prototypes bij te werken.

Deze methode is alleen beschikbaar voor gebruikers van het type Admin en Super admin. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Eigenschappen van grafiekprototype moeten worden bijgewerkt.

De eigenschap graphid moet worden gedefinieerd voor elk prototype van een grafiek, allemaal andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, blijven alle andere ongewijzigd.

Aanvullend op het standaard grafiek prototype eigenschappen, accepteert de methode het volgende: parameters.

Parameter	Type	Beschrijving
gitems	array	Graph items om bestaande grafiekitems te vervangen. Als een grafiekitem de eigenschap `gitemid' heeft gedefinieerd, wordt het bijgewerkt, anders wordt er een nieuw grafiekitem gemaakt.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte grafiek bevat prototypes onder de eigenschap graphids.

Voorbeelden

Het wijzigen van de grootte van een grafiek-prototype

Wijzig de grootte van een grafiek-prototype naar 1100 bij 400 pixels.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "graphprototype.update",
           "params": {
               "graphid": "439",
               "width": 1100,
               "height": 400
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "graphids": [
                   "439"
               ]
           },
           "id": 1
       }

Bron

CGraphPrototype::update() in ui/include/classes/api/services/CGraphPrototype.php.

Documentation