BaseComponent
cdf.components. BaseComponent
The BaseComponent. Module which holds everything related to components.
AMD Module
require(["cdf/components/BaseComponent"], function(BaseComponent) { /* code goes here */ });
Extends
Constructor
Name | Description |
---|---|
new BaseComponent(properties) | Holds the core functionalities present in all components. |
Members
Name | Description |
---|---|
elapsedSinceSplit : Protected | Number of milliseconds since the timer split. |
elapsedSinceStart : Protected | Number of milliseconds since the timer start. |
htmlObject : Protected | HTML element identifier where the component is rendered. |
initInstance : Deprecated Protected | The Dashboard instance to which the component belongs. |
isManaged : Protected | Managed flag. |
logColor : Protected | Color to use while logging messages. |
name : Protected | Name of the component. |
postChange : | Function to be executed after the components parameter value changes. |
preChange : | Function to be executed before the components parameter value changes. |
timerSplit : Protected | Start date for the timer split. |
timerStart : Protected | Start date for the timer start. |
type : Protected | Type of the component. |
visible : Protected | Visibility flag. |
Methods
Name | Description |
---|---|
clear() | Clears the component HTML element. |
clone(parameterRemap, componentRemap, htmlRemap) : cdf.components.BaseComponent | Clones a component. |
copyEvents(target, events) | General copy events methods. |
focus() | Focus the first placeholder DOM element on the component. |
getAddIn(slot, addIn) : cdf.AddIn | Gets an add-in for this component. |
getAddInOptions(slot, addIn) : object | Gets an add-in option. |
getValuesArray() : Array.<<code>object > Deprecated | Gets the values array property. |
hasAddIn(slot, addIn) : boolean | Returns |
parseArray(jData, includeHeader) : Array.<<code>object > Deprecated | Builds an array with the data received from the server in another format. |
parseArrayCda(jData, includeHeader) : Array.<<code>object > Deprecated | Builds an array with the data received. |
placeholder(selector) : jQuery | Getter for the component's DOM element. |
setAddInOptions(slot, addIn, options) | Sets the options for an add-in. |
Events
Name | Description |
---|---|
all | Event triggered by any other event. |
Constructor Details
new BaseComponent(properties) | ||||||
---|---|---|---|---|---|---|
Constructs a BaseComponent. Source: components/BaseComponent.js, line 160
|
Members Details
elapsedSinceSplit: Protected |
---|
Number of milliseconds since the timer split. Source: components/BaseComponent.js, line 98 Default Value: -1 |
elapsedSinceStart: Protected |
---|
Number of milliseconds since the timer start. Source: components/BaseComponent.js, line 108 Default Value: -1 |
htmlObject: Protected |
---|
The HTML element identifier, unique in the HTML page, where the component is rendered. |
initInstance: Deprecated Protected |
---|
The Dashboard instance to which the component belongs. |
isManaged: Protected |
---|
Managed flag. Source: components/BaseComponent.js, line 66 Default Value: true |
logColor: Protected |
---|
Color to use while logging messages. Source: components/BaseComponent.js, line 118 Default Value: undefined |
name: Protected |
---|
The name of the component. Its name needs to be unique in the dashboard to which they belong. |
postChange: |
---|
Function to be executed after the components parameter value changes. |
preChange: |
---|
Function to be executed before the components parameter value changes. |
timerSplit: Protected |
---|
Start date for the timer split. Source: components/BaseComponent.js, line 88 Default Value: 0 |
timerStart: Protected |
---|
Start date for the timer start. Source: components/BaseComponent.js, line 78 Default Value: 0 |
type: Protected |
---|
The type of the component, usually the class name of the component. |
visible: Protected |
---|
Visibility flag. Source: components/BaseComponent.js, line 56 Default Value: true |
Methods Details
clear() |
---|
Clears the component HTML element. |
clone(parameterRemap, componentRemap, htmlRemap) : cdf.components.BaseComponent | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Clones a component. Source: components/BaseComponent.js, line 235
|
copyEvents(target, events) | |||||||||
---|---|---|---|---|---|---|---|---|---|
General copy events methods. Given a target component and an event list, adds the component as a listener for all events in the list. Source: components/BaseComponent.js, line 216
|
focus() |
---|
Focus the first placeholder DOM element on the component. |
getAddIn(slot, addIn) : cdf.AddIn | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets an add-in for this component. Source: components/BaseComponent.js, line 295
|
getAddInOptions(slot, addIn) : object | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets an add-in option. Source: components/BaseComponent.js, line 505
|
getValuesArray() : Array.<<code>object > Deprecated | ||||
---|---|---|---|---|
Gets the values array property, if one is defined. Otherwise, issues a call to the server to get data. Source: components/BaseComponent.js, line 329
|
hasAddIn(slot, addIn) : boolean | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns Source: components/BaseComponent.js, line 312
|
parseArray(jData, includeHeader) : Array.<<code>object > Deprecated | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Builds an array with the data received from the server in another format. Source: components/BaseComponent.js, line 403
|
parseArrayCda(jData, includeHeader) : Array.<<code>object > Deprecated | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Builds an array with the data received from the server in CDA format. Source: components/BaseComponent.js, line 446
|
placeholder(selector) : jQuery | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Getter for the component's DOM element. Returns the jQuery Source: components/BaseComponent.js, line 171
|
setAddInOptions(slot, addIn, options) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Sets the options for an add-in. Source: components/BaseComponent.js, line 486
|
Events Details
all |
---|
The Source: components/_doc/events.jsdoc, line 19 See also: Backbone Events catalog. |
Type Definitions
TimerInfo: Static | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The TimerInfo object.
|