AddIn
cdf.AddIn
Creates a new add-in. Add-ins come in two varieties: Static add-ins represent static data or behavior, while Scriptable add-ins represent dynamic, context-dependent behavior.
AMD Module
require(["cdf/AddIn"], function(AddIn) { /* code goes here */ });
Constructor
Name | Description |
---|---|
new AddIn(options) | Class that allows creating Static or Scriptable add-ins. |
Methods
Name | Description |
---|---|
call(target, state, options) : Object | Object | Executes the add-in |
getLabel() : string | Returns the add-in label. |
getName() : string | Returns the add-in name. |
setDefaults(defaults) | Sets the default values of the configurable settings. |
Constructor Details
new AddIn(options) | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The constructor of an add-in. Source: AddIn.js, line 20
|
Methods Details
call(target, state, options) : Object | Object | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Call the add-in. If the add-in is static, all parameters are irrelevant, and this method will simply return the value of In a dynamic add-in, the implementation will be passed to the target DOM Element (whatever element is relevant, e.g. the element that was clicked on or the table cell that is being processed), a state object with whatever context is relevant for the add-in to fulfill its purpose, and optionally any overriding options. Components are allowed to pass Source: AddIn.js, line 153
|
getLabel() : string | ||||
---|---|---|---|---|
Returns the add-in label. Source: AddIn.js, line 114
|
getName() : string | ||||
---|---|---|---|---|
Returns the add-in name. Source: AddIn.js, line 124
|
setDefaults(defaults) | ||||||
---|---|---|---|---|---|---|
Sets the default values of the configurable settings. If Source: AddIn.js, line 176
|