Chart legend component. More...
Public Member Functions | |
notifyViewHandler (reason, data1, data2, data3) | |
Notification that the dataController associated with this dataView. More... | |
parseStyleSVG (style) | |
Utility method. More... | |
renderContents () | |
Client-side method to render this control. | |
setBorderStyle (borderStyleAttribute, value) | |
Insert a single style item into the multi-item legendBorderStyle. | |
setProperty (property, value, value2) | |
Set the value of a named property. | |
transformColor (color) | |
Some charts may have use SVG colors. More... | |
![]() | |
dragFinishHandler (dragData) | |
This is called when a drag operation started within this component. More... | |
dragHandler () | |
This is called by the layout manager when a drag-and-drop operation. More... | |
dragNotifyHandler (dragData) | |
This is called by the layout manager when a drag operation. More... | |
dragStartHandler (dragData) | |
This is called when a drag operation is started within this component. More... | |
dropHandler () | |
This is called by the layout manager when a drag-and-drop operation. More... | |
dropStartHandler (dragData) | |
This is called when a data drop operation is started within this component. More... | |
exposeComponent () | |
This manages the ondisplay event callback handling. More... | |
getEnclosingDiv () | |
Client-side method returns the div element that encloses. More... | |
_.Library.String | getHidden () |
Return whether this component is hidden. | |
getHintElement () | |
Client-side method returns the HTML element that displays. More... | |
getLabelElement () | |
Client-side method returns the HTML element that displays. More... | |
onDisplayHandler () | |
This client callback is called from exposeComponent after. More... | |
onEndModalHandler (zindex) | |
Notification that this component is about to stop being modal. | |
onPopupAction (popupName, action, value) | |
This client event, if present, is fired when a popup page has specified. More... | |
onRefreshContents () | |
This client callback is called just from refreshContents. More... | |
onStartModalHandler (zindex) | |
Notification that this component is about to become modal. More... | |
refreshContents (sync) | |
This method, called from a client page, invokes this component's. More... | |
setHidden (flag) | |
If flag is true, hide this component. More... | |
setOverlayMode (mode) | |
Expirimental: do not use. More... | |
startProgressBar (div) | |
Start the display of a progress bar within display. More... | |
stopProgressBar () | |
Stop the timer used by the Progress bar. | |
![]() | |
_.Library.Status | OnNew (_.Library.RawString initvalue) |
Constructor for Zen objects. More... | |
findElement (subid) | |
Client-side utility method that finds an HTML element with a. More... | |
fireOnUpdateEvent () | |
This is called when an object is updated from the server. More... | |
_.Library.String | getProperty (property, key) |
Return the value of a named property (i.e. More... | |
getSettings (settings) | |
Client-side method that returns a list of this component's. More... | |
getType () | |
Returns the component type of this object. More... | |
invokeSuper (method, args) | |
Invoke the superclass method method of the current. More... | |
isOfType (type) | |
Returns true if this object is of the given component type. More... | |
makeId (subid) | |
client-side utility method that constructs a component-specific id More... | |
onCreate () | |
This client method, if present, is called when this component is. More... | |
onDelete () | |
This client method, if present, is called when this component is. More... | |
onSerialize () | |
This client event, if present, is fired before a component. More... | |
onloadHandler () | |
This client event, if present, is fired when the page is loaded. | |
onunloadHandler () | |
This client event, if present, is fired when the page is unloaded. More... | |
onupdateHandler () | |
This client method, if present, is fired when the object is updated from the server. | |
render () | |
This causes a component that draws its contents dynamically. More... | |
renderSVG (document, parent) | |
This method is only needed for SVG components. More... | |
![]() | |
_.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
This callback method is invoked when the current object is added to the SaveSet,. More... | |
_.Library.Status | OnClose () |
This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
_.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
_.Library.Status | OnNew () |
This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
_.Library.Status | OnValidateObject () |
This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
![]() | |
_.Library.Status | XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments) |
Serialize an XML enabled class as an XML document and write. More... | |
_.Library.Status | XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent) |
Serialize an XML enabled class as an XML document and appends it to a stream. More... | |
_.Library.Status | XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent) |
Serialize an XML enabled class as an XML document and write it to a string. More... | |
![]() | |
_.Library.Status | AcquireDataFromController () |
Server-side method used by dataView implementation classes to. More... | |
getController () | |
Get the dataController component associated with this dataView, if present. More... | |
sendEventToController (reason, data1, data2, data3) | |
If connected, send an event to a dataController. More... | |
setControllerId (id) | |
Set the controller id for this dataView and establish a connection. More... | |
Public Attributes | |
chartId | |
id of <class>DeepSee.SVGComponent.chart</class> component this More... | |
legendBorderStyle | |
Style to apply to border lines in the legend. More... | |
legendBoxStyle | |
Style to apply to the legendBox. More... | |
legendLabels | |
Store legend Labels here so available to UI.ChartPDF and Widget.pivot. More... | |
legendPosition | |
Remember the legend position. More... | |
legendStyle | |
Style to apply to the legend table. More... | |
legendTitle | |
Store legend title here so available to UI.ChartPDF and Widget.pivot. More... | |
orientation | |
Specify which way the legend is layed out. More... | |
showLegendTitle | |
More... | |
![]() | |
align | |
Specifies how this component should be horizontally aligned within its layout cell. More... | |
containerStyle | |
CSS style applied to the td element used to contain this child component within. More... | |
dragEnabled | |
If this value is true and dragAndDrop is enabled for the page, then. More... | |
dropEnabled | |
If this value is true and dragAndDrop is enabled for the page, then. More... | |
enclosingClass | |
Optional CSS class used for this component's enclosing div. More... | |
enclosingStyle | |
Optional CSS style applied to this component's enclosing div. More... | |
error | |
Run-time value; Set to indicate an error within this component. More... | |
height | |
Specifies the height of this component with respect to its container. More... | |
hidden | |
If true, this component is hidden. More... | |
hint | |
User defined hint text used to display additional hint text for this component. More... | |
hintClass | |
Optional CSS class used for the component hint. More... | |
hintStyle | |
User defined style used for the component hint. More... | |
label | |
User defined label used to label this component. More... | |
labelClass | |
Optional CSS class used for the component label. More... | |
labelDisabledClass | |
Optional CSS class used for the component label when disabled. More... | |
labelStyle | |
User defined style used for the component label. More... | |
onafterdrag | |
onafterdrag event handler: More... | |
onbeforedrag | |
onbeforedrag event handler: More... | |
ondrag | |
ondrag event handler: More... | |
ondrop | |
ondrop event handler: More... | |
onhide | |
onhide event handler: More... | |
onrefresh | |
onrefresh event handler: More... | |
onshow | |
onshow event handler: More... | |
showLabel | |
Controls whether a label is displayed for this component. More... | |
slice | |
User-defined number of units of relative space this. More... | |
title | |
Help text (tool tip) displayed when mouse hovers over this component (or its label). More... | |
valign | |
Specifies how this component should be vertically aligned within its layout cell. More... | |
width | |
Specifies the width of this component with respect to its container. More... | |
![]() | |
aux | |
@qualifier final This is an auxiliary property that is provided More... | |
composite | |
@qualifier final For components that are created as part of a composite component, More... | |
id | |
@qualifier final This is a unique identifier that is used to distinguish this object More... | |
index | |
@qualifier final System-assigned index number used internally to identify this component. More... | |
name | |
@qualifier final Name of this object. More... | |
onupdate | |
onupdate event handler: More... | |
parent | |
@qualifier final Link to the component that contains this object More... | |
tuple | |
@qualifier final Special property indicating which tuple of a More... | |
visible | |
This property indicates whether a component is visible and thus layed out. More... | |
window | |
@qualifier final This is a client-only property that refers to the JavaScript More... | |
![]() | |
controller | |
Internal property. More... | |
controllerId | |
Optional. More... | |
onnotifyView | |
onnotifyView event handler: More... | |
Static Public Attributes | |
DOMAIN = None | |
Localization domain. | |
![]() | |
DEFAULTENCLOSINGCLASS = None | |
Subclasses can set this to change default enclosingClass used for this. More... | |
DEFAULTHEIGHT = None | |
Subclasses can set this to change default height for a component. | |
DEFAULTHIDDEN = None | |
Subclasses can set this to change default hidden property for a component. | |
DEFAULTHINTCLASS = None | |
Subclasses can set this to change default css class used for hints. | |
DEFAULTLABELCLASS = None | |
Subclasses can set this to change default css class used for labels. | |
DEFAULTLABELDISABLEDCLASS = None | |
Subclasses can set this to change default css class used for disabled labels. | |
DEFAULTVISIBLE = None | |
Subclasses can set this to change default visibilty for a component. | |
DEFAULTWIDTH = None | |
Subclasses can set this to change default width for a component. | |
![]() | |
DEFAULTVISIBLE = None | |
Subclasses can set this to change default visibilty for a component. | |
INCLUDEFILES = None | |
CSV list of additional include files (either .js or .css) that. More... | |
MODULE = None | |
If set, this indicates that this system component should be. More... | |
NAMESPACE = None | |
This is the XML namespace used for library components. | |
POSTCOMPILEACTIONS = None | |
This is a comma-delimited list of which post-compile actions this component. More... | |
USECOMMONDIRECTORY = None | |
If true, then the include files generated for this component, are placed in the. More... | |
XMLFORMAT = None | |
If XMLFORMAT="Literal", then only support for literal format import and export is generated. More... | |
XMLIGNOREINVALIDATTRIBUTE = None | |
By setting this to 0, we disallow use of invalid attribute names in Zen XML documents. | |
![]() | |
CAPTION = None | |
Optional name used by the Form Wizard for a class when generating forms. More... | |
JAVATYPE = None | |
The Java type to be used when exported. | |
PROPERTYVALIDATION = None | |
This parameter controls the default validation behavior for the object. More... | |
![]() | |
ATTRIBUTEQUALIFIED = None | |
ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More... | |
ELEMENTQUALIFIED = None | |
ELEMENTQUALIFIED controls the format of exported XML. More... | |
NAMESPACE = None | |
NAMESPACE specifies the XML namespace to be used when projecting the. More... | |
SUPPRESSTYPEPREFIX = None | |
SUPPRESSTYPEPREFIX allows the type name that refers to this class. More... | |
XMLDEFAULTREFERENCE = None | |
XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More... | |
XMLENABLED = None | |
If this parameter is true then XML-enabling methods. More... | |
XMLFORMAT = None | |
The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More... | |
XMLIGNOREINVALIDATTRIBUTE = None | |
The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More... | |
XMLIGNOREINVALIDTAG = None | |
The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More... | |
XMLIGNORENULL = None | |
XMLIGNORENULL allows the programmer to override the default XML handling. More... | |
XMLINCLUDEINGROUP = None | |
XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More... | |
XMLINHERITANCE = None | |
If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More... | |
XMLNAME = None | |
This parameter provides the default XMLNAME for the class. More... | |
XMLNIL = None | |
The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More... | |
XMLNILNOOBJECT = None | |
The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More... | |
XMLPREFIX = None | |
The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More... | |
XMLSEQUENCE = None | |
If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More... | |
XMLSUMMARY = None | |
The summary fields to be used when an object is referenced are specified. More... | |
XMLTYPE = None | |
This parameter provides the default XMLTYPE for the class. More... | |
XMLUNSWIZZLE = None | |
If the XMLUNSWIZZLE parameter is set to 1, then single object. More... | |
XMLUSEEMPTYELEMENT = None | |
If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More... | |
Private Member Functions | |
DrawHTML () | |
Static HTML display method: draw the BODY of this component. More... | |
Additional Inherited Members | |
![]() | |
_.Library.Status | XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist) |
Write the DTD to the current device for this XML enabled class serialized as. More... | |
_.Library.RegisteredObject | XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref) |
Get an instance of an XML enabled class. More... | |
_.Library.Status | XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema) |
Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More... | |
_.Library.String | XMLSchemaNamespace () |
Get the namespace to which this class belongs for use in schema generation. More... | |
_.Library.Status | XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly) |
Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More... | |
Chart legend component.
This provides an alternate way to display a legend for a Zen chart component.
To use the chart legend you must connect it to a data source using the <property>controllerId</property> property as well as a chart using the <property>chartId</property> property. The <property>orientation</property> property specifies how the legend is layed out.
|
private |
Static HTML display method: draw the BODY of this component.
as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
Reimplemented from object.
notifyViewHandler | ( | reason, | |
data1, | |||
data2, | |||
data3 | |||
) |
Notification that the dataController associated with this dataView.
has raised an event.
parseStyleSVG | ( | style | ) |
Utility method.
Split an SVG css value into individual style values.
Return an object containing these values.
transformColor | ( | color | ) |
Some charts may have use SVG colors.
This is a crude translator.
chartId |
id of <class>DeepSee.SVGComponent.chart</class> component this
legend is associated with.
Note: if this component is placed within a composite element, then the chart must be within the same composite element.
legendBorderStyle |
Style to apply to border lines in the legend.
legendBoxStyle |
Style to apply to the legendBox.
legendLabels |
Store legend Labels here so available to UI.ChartPDF and Widget.pivot.
legendPosition |
Remember the legend position.
legendStyle |
Style to apply to the legend table.
legendTitle |
Store legend title here so available to UI.ChartPDF and Widget.pivot.
orientation |
Specify which way the legend is layed out.
showLegendTitle |