Class: PieChart

Extends

• otris.gadget.gui.Transferable

Methods

inherited addClientFunction(clientFunction)

Adds a JavaScript Function to this Transferable Object. When the Object is transfered to the client the functions added to this Object will be available on the client side.

Name	Type	Description
clientFunction	function	The function to be added to the clientFunctions of this Object. (Can be a JavaScript Function or an Object returned by otris.gadget.util.FunctionUtils.getFunctionObject)

inherited addContainerButton(buttonConfig){object}

Adds a container button.
If the gadget is displayed in a dialog the container buttons are rendered as dialog buttons (bottom right corner of the dialog).
Otherwise the container buttons are ignored

Name	Type	Description
buttonConfig	object	button config object Name Type Default Description id string button id label string button label clickFunction string name of the client function to execute on click disabled boolean false optional

• Since:

  • Documents 5.0e

Returns:

Type	Description
object	buttonConfig

Example

// Alternative gadget action button
gadgetForm.addContainerButton({ id: "myCustomSaveButton", label: "Speichern", clickFunction: "saveGadgetData" });
gadgetForm.addClientFunction(function saveGadgetData(event) {
  var gForm = documentsContext.getGadgetContext().getClientObject();
  gForm.submitForm({ gadgetAction: "processForm" }, { showBusyPanel: true });
});

addHandler(event, handler)

Adds a handler function to this PieChart which will be fired when the given event is triggered

The Piechart object supports the following events:

• itemmouseover


• itemmouseout


• itemmousedown


• itemmouseup

An "item" object is passed to the function registered to any of these events.
The stored data of this item is available in the function through: "item.storeItem.data".

Name	Type	Description
event	string	the event which fires the handler
handler	function	the handler function

Example

pie.addHandler("itemmousedown", function(item){
         var itemData = item.storeItem.data;
         alert(itemData.name + ": " + itemData.value);
 });

inherited addPdfButton(config)

Adds a button to download the displayed gadget as pdf. The button will show on hover in the left top corner of the gadget.

Name	Type	Description
config	object	optional config object Name Type Default Description filename string content.pdf optional filename of the pdf for download buttonStyle string left: 200px; optional style for the pdf button to be applied to

• Since:

  • Documents 5.0d

Example

myGadget.addPdfButton({filename: "myCustomFilename.pdf", buttonStyle: "left: 200px; });

inherited addSettings(option)

Adds a setting (an option that can be defined by the user) to the gadget.

Name	Type	Description
option	GadgetSetting | Array.<GadgetSetting>	the setting(s) to add to the gadget.

• Since:

  • Documents 5.0a

inherited onGadgetLoad(onloadHandler)

Sets an onLoad handler for the Gadget. The handler is executed when the gadget is displayed at the client.

Name	Type	Description
onloadHandler	function | string	the handler to be executed (must be either a javascript function or a string representing a function)

inherited setContainerButtons(containerButtonConfigs)

Set the container buttons.
Please note that existing default buttons are removed by this operation.

Name	Type	Description
containerButtonConfigs	Array.<object>	array of button config objects Name Type Default Description id string button id label string button label clickFunction string name of the client function to execute on click disabled boolean false optional

• Since:

  • Documents 5.0e

• See:

  • otris.gadget.gui.Transferable#addContainerButton

inherited setContextData(contextData)

Set additional data which is serialized with JSON.stringify() and then transferred to the client
On the client side the the context data is accessible with the GadgetContext

Name	Type	Description
contextData	any	the context data

• Since:

  • Documents 5.0c

Example

var htmlGadget = new otris.gadget.gui.HTML("<h1>Only a simple example</h1>");
var myGadgetData = {
    mySpecialId: 44137,
    myIndexArray: [1,7,6,3,2],
    myTitle: "A special GadgetTitle"
};
htmlGadget.setContextData(myGadgetData);

setDataAction(dataAction)

Sets the name of the gadgetAction to be called for retrieveing the Data for the PieChart

Name	Type	Description
dataAction	string	name of the gadgetAction

• Deprecated

  • please use setDataGadgetConfig

setDataGadgetConfig(dataGadgetConfig)

Sets the gadgetConfig Object for retrieving the data

Name	Type	Description
dataGadgetConfig	GadgetConfig	the new config object

setDataParams(dataParams)

Function: setDataParams

Name	Type	Description
dataParams	object	a JavaScript Object containing each parameter as a property.

• Deprecated

  • please use setDataGadgetConfig

setDataScript(dataScript)

Sets the dataScript to use for this PieChart

Name	Type	Description
dataScript	string	name of the dataScript

• Deprecated

  • please use setDataGadgetConfig

setGadgetHeight(height)

Sets the height of the PieChart. The PieChart must have a given height. Its height can not be determined dynamicly.

Name	Type	Default	Description
height	number	500	the new height in pixels

setGadgetWidth(width)

Sets the Width of the PieChart. The PieChart must have a given width. Its width can not be determined dynamicly.

Name	Type	Default	Description
width	number	500	the new width in pixels

inherited setNavibarEntry(gadgetConfig, label)

Add a navibar entry. Define a gadgetConfig that reloads the gadget.
Only works if the gadget ist displayed in main list view area.

Name	Type	Description
gadgetConfig	object	gadgetConfig
label	string	optional label for the navibar entry (defaults to the gadget title)

• Since:

  • Documents 5.0e

inherited setStyle(name, value)

Sets a style attribute of the html container

Name	Type	Description
name	string	the name of the style parameter (i.e. "height")
value	string	the value of the style parameter (i.e. "100px")

inherited setTitle(title)

Sets the Title of the Form

Name	Type	Description
title	string	the title of the form (will be displayed as the window header on dashboards)

setTooltipRenderer(fn)

Sets the TooltipRenderer function for this pie chart

Name	Type	Description
fn	function	the function which will be called to render the tooltip of the differend sections of this pie chart

inherited store(key, value)

Stores data that can later be accessed on client side.
ATTENTION: The store used in this method is global.
Use setContextData to store data for this gadget instance.

Name	Type	Description
key	string	the key to store the data
value	any	the value, or object that should be stored

transfer()

Make this object ready for beeing transferred to the client