Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [Component] >  [chartLegend]
Private  Storage   

class %DeepSee.Component.chartLegend extends %ZEN.Component.component, %ZEN.Component.dataView

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 controllerId property as well as a chart using the chartId property. The orientation property specifies how the legend is layed out.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 9 10


Summary

Properties
%condition %controller %import %includeFiles
%page %resource align aux
chartId composite containerStyle controller
controllerId dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle legendBorderStyle legendBoxStyle legendLabels
legendPosition legendStyle legendTitle name
onafterdrag onbeforedrag ondrag ondrop
onhide onnotifyView onrefresh onshow
onupdate orientation parent showLabel
showLegendTitle slice title tuple
valign visible width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler exposeComponent
findElement fireOnUpdateEvent getController getEnclosingDiv
getHidden getHintElement getLabelElement getProperty
getSettings getType invokeSuper isOfType
makeId notifyViewHandler onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onloadHandler onunloadHandler
onupdateHandler parseStyleSVG refreshContents render
renderContents renderSVG sendEventToController setBorderStyle
setControllerId setHidden setOpacity setOverlayMode
setProperty startProgressBar stopProgressBar transformColor


Parameters

• parameter DEFAULTENCLOSINGCLASS = "dslegendDiv";
Subclasses can set this to change default enclosingClass used for this component.
• parameter DOMAIN = "%DeepSee";
Localization domain
• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties

• property chartId as %ZEN.Datatype.id(COMPONENTTYPE="chart");
id of %DeepSee.SVGComponent.chart 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.
• property legendBorderStyle as %ZEN.Datatype.style;
Style to apply to border lines in the legend.
• property legendBoxStyle as %ZEN.Datatype.style;
Style to apply to the legendBox
• property legendLabels as %ZEN.Datatype.csv(XMLPROJECTION="none");
Store legend Labels here so available to UI.ChartPDF and Widget.pivot
• property legendPosition as %ZEN.Datatype.string(VALUELIST="top,left,bottom,right,none",XMLPROJECTION="none");
Remember the legend position.
• property legendStyle as %ZEN.Datatype.style;
Style to apply to the legend table.
• property legendTitle as %ZEN.Datatype.caption(XMLPROJECTION="none");
Store legend title here so available to UI.ChartPDF and Widget.pivot
• property orientation as %ZEN.Datatype.string(VALUELIST="horizontal,vertical") [ InitialExpression = "vertical" ];
Specify which way the legend is layed out.
• property showLegendTitle as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 1 ];

Methods

• method %DrawHTML()
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.
• method notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
• method parseStyleSVG(style) [ Language = javascript ]
Utility method. Split an SVG css value into individual style values. Return an object containing these values.
• method renderContents() [ Language = javascript ]
Client-side method to render this control.
• method setBorderStyle(borderStyleAttribute, value) [ Language = javascript ]
Insert a single style item into the multi-item legendBorderStyle
• method setOpacity(opacity) [ Language = javascript ]
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method transformColor(color) [ Language = javascript ]
Some charts may have use SVG colors. This is a crude translator.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.