Package ptolemy.vergil.basic.export.web
Class DygraphsJSPlotterAttribute
- java.lang.Object
-
- ptolemy.kernel.util.NamedObj
-
- ptolemy.kernel.util.Attribute
-
- ptolemy.kernel.util.AbstractSettableAttribute
-
- ptolemy.data.expr.Variable
-
- ptolemy.data.expr.Parameter
-
- ptolemy.data.expr.StringParameter
-
- ptolemy.vergil.basic.export.web.WebContent
-
- ptolemy.vergil.basic.export.web.JSPlotterAttribute
-
- ptolemy.vergil.basic.export.web.DygraphsJSPlotterAttribute
-
- All Implemented Interfaces:
java.lang.Cloneable
,HasTypeConstraints
,Typeable
,Changeable
,Debuggable
,DebugListener
,Derivable
,ModelErrorHandler
,MoMLExportable
,Moveable
,Nameable
,Settable
,ValueListener
,WebExportable
public class DygraphsJSPlotterAttribute extends JSPlotterAttribute
Attribute for generating the HTML file with JavaScript to plot simulation results using the Dygraphs library. The HTML file is generated by "Export to Web". An @link IconLink attribute can be customized with the generated file to open the HTML page.Configure the export parameters by double-clicking on the attribute, then click the "Configure" button).
dataJSON contains the data series to be plotted in the chart area of the page. Two JavaScript array formats are acceptable:
- [{name:"series 1", value:[[x1, y1], [x2, y2], ..., [xn, yn]]}, {name:"series 2", value:[[x'1, y'1], [x'2, y'2], ..., [x'n, y'n]]}, ...]
- [{name:"series 1", value:[{x:x1, y:y1}, {x:x2, y:y2}, ..., {x:xn, y:yn}]}, {name:"series 2", value:[{x:x'1, y:y'1}, {x:x'2, y:y'2}, ..., {x:x'n, y:y'n}]}, ...]
- [{name:"series 1", value:[{x:x1, y:y1, text:"event 1 info"}, {x:x2, y:y2, text:"event 2 info"}, ...]}, {...}, ...]
- Since:
- Ptolemy II 10.0
- Version:
- $Id$
- Author:
- Baobing (Brian) Wang
- Pt.AcceptedRating:
- Red (cxh)
- Pt.ProposedRating:
- Red (cxh)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class ptolemy.data.expr.Variable
Variable.CircularDependencyError, Variable.VariableScope
-
Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj
NamedObj.ContainedObjectsIterator
-
Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable
Settable.Visibility
-
-
Field Summary
-
Fields inherited from class ptolemy.vergil.basic.export.web.JSPlotterAttribute
autoResize, customContent, dataConnectWidth, dataJSON, dataMarkerRadius, drawHorizontalGridLine, drawVerticalGridLine, enableDataMarker, enableEventsMarker, enableLegend, eventsConnectWidth, eventsJSON, eventsMarkerRadius, graphHeight, graphWidth, horizontalAlign, linkTarget, outputDataFile, outputHTMLFile, saveDataToFile, verticalAlign, xAxisMode, xAxisTitle, yAxisMode, yAxisTitle
-
Fields inherited from class ptolemy.vergil.basic.export.web.WebContent
_icon, displayText, height, width
-
Fields inherited from class ptolemy.data.expr.Variable
_currentExpression, _needsEvaluation, _parserScope, _parseTreeValid, _suppressVariableSubstitution, _valueListeners
-
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
-
Fields inherited from interface ptolemy.kernel.util.Settable
EXPERT, FULL, NONE, NOT_EDITABLE
-
-
Constructor Summary
Constructors Constructor Description DygraphsJSPlotterAttribute(NamedObj container, java.lang.String name)
Construct an attribute that will generate HTML to plot using the Dygraphs library.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
_provideAttributes(WebExporter exporter)
Provide content to the specified web exporter to be included in a web page for the container of this object.-
Methods inherited from class ptolemy.vergil.basic.export.web.JSPlotterAttribute
getBasicConfig, getBodyContent, getHeaderContent, getHTMLPageContent, getMimeType, insertBodyContent, insertHeaderContent, isOverwriteable
-
Methods inherited from class ptolemy.vergil.basic.export.web.WebContent
_provideElements, attributeChanged, clone, provideContent
-
Methods inherited from class ptolemy.data.expr.StringParameter
stringValue
-
Methods inherited from class ptolemy.data.expr.Parameter
addChoice, exportMoML, getChoices, removeAllChoices, removeChoice
-
Methods inherited from class ptolemy.data.expr.Variable
_description, _evaluate, _getCurrentExpression, _notifyValueListeners, _parseIfNecessary, _propagate, _propagateToValueListeners, _propagateValue, _setToken, _setTokenAndNotify, addValueListener, getDeclaredType, getExpression, getFreeIdentifiers, getParserScope, getScope, getScope, getToken, getType, getTypeTerm, getValueAsString, getVariable, getVisibility, invalidate, isKnown, isLazy, isStringMode, isSuppressVariableSubstitution, isTypeAcceptable, removeValueListener, reset, setContainer, setExpression, setLazy, setName, setParseTreeEvaluator, setStringMode, setSuppressVariableSubstitution, setToken, setToken, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, setUnknown, setValueListenerAsWeakDependency, setVisibility, stringRepresentation, toString, typeConstraintList, typeConstraints, validate, valueChanged
-
Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute
getDefaultExpression
-
Methods inherited from class ptolemy.kernel.util.Attribute
_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, updateContent
-
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, uniqueName, validateSettables, workspace
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getContainer, getFullName, getName, getName, setName
-
Methods inherited from interface ptolemy.kernel.util.Settable
getDisplayName
-
Methods inherited from interface ptolemy.vergil.basic.export.web.WebExportable
provideContent
-
-
-
-
Constructor Detail
-
DygraphsJSPlotterAttribute
public DygraphsJSPlotterAttribute(NamedObj container, java.lang.String name) throws IllegalActionException, NameDuplicationException
Construct an attribute that will generate HTML to plot using the Dygraphs library.- Parameters:
container
- The container.name
- The name.- Throws:
IllegalActionException
- If the superclass throws it.NameDuplicationException
- If the superclass throws it.
-
-
Method Detail
-
_provideAttributes
protected void _provideAttributes(WebExporter exporter) throws IllegalActionException
Provide content to the specified web exporter to be included in a web page for the container of this object.- Overrides:
_provideAttributes
in classJSPlotterAttribute
- Parameters:
exporter
- The web exporter to write content to- Throws:
IllegalActionException
- If evaluating the value of this parameter fails, or creating a web attribute fails.
-
-