%DeepSee.Component.chartLegend
Class %DeepSee.Component.chartLegend Extends (%ZEN.Component.component, %ZEN.Component.dataView) [ System = 3 ]
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.
Parameters
NAMESPACE
Parameter NAMESPACE = "http://www.intersystems.com/deepsee";
DOMAIN
Parameter DOMAIN = "%DeepSee";
Localization domain
DEFAULTENCLOSINGCLASS
Parameter DEFAULTENCLOSINGCLASS = "dslegendDiv";
Properties
chartId
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.
legendStyle
Property legendStyle As %ZEN.Datatype.style;
Style to apply to the legend table.
legendBorderStyle
Property legendBorderStyle As %ZEN.Datatype.style;
Style to apply to border lines in the legend.
legendBoxStyle
Property legendBoxStyle As %ZEN.Datatype.style;
Style to apply to the legendBox
orientation
Property orientation As %ZEN.Datatype.string(VALUELIST = "horizontal,vertical") [ InitialExpression = "vertical" ];
Specify which way the legend is layed out.
legendPosition
Property legendPosition As %ZEN.Datatype.string(VALUELIST = "top,left,bottom,right,none", XMLPROJECTION = "none");
Remember the legend position.
legendLabels
Property legendLabels As %ZEN.Datatype.csv(XMLPROJECTION = "none");
Store legend Labels here so available to UI.ChartPDF and Widget.pivot
legendTitle
Property legendTitle As %ZEN.Datatype.caption(XMLPROJECTION = "none");
Store legend title here so available to UI.ChartPDF and Widget.pivot
showLegendTitle
Property showLegendTitle As %ZEN.Datatype.boolean(XMLPROJECTION = "none") [ InitialExpression = 1 ];
XDatas
Style
XData Style
defines style sheet used by this component
Methods
%DrawHTML
Method %DrawHTML()
renderContents
ClientMethod renderContents() [ Language = javascript ]
Client-side method to render this control.
transformColor
ClientMethod transformColor(color) [ Language = javascript ]
Some charts may have use SVG colors. This is a crude translator.
setProperty
ClientMethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
parseStyleSVG
ClientMethod parseStyleSVG(style) [ Language = javascript ]
Utility method. Split an SVG css value into individual style values. Return an object containing these values.
acquireData
ClientMethod acquireData() [ Internal, Language = javascript ]
Connect to controller.
notifyViewHandler
ClientMethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
itemClick
ClientMethod itemClick(idx) [ Internal, Language = javascript ]
User click on legend item.
setOpacity
ClientMethod setOpacity(opacity) [ Language = javascript ]
setBorderStyle
ClientMethod setBorderStyle(borderStyleAttribute, value) [ Language = javascript ]
Insert a single style item into the multi-item legendBorderStyle