%DeepSee.Component.chartLegend
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.
Property Inventory
- chartId
- legendBorderStyle
- legendBoxStyle
- legendLabels
- legendPosition
- legendStyle
- legendTitle
- orientation
- showLegendTitle
Method Inventory
- %DrawHTML()
- notifyViewHandler()
- parseStyleSVG()
- renderContents()
- setBorderStyle()
- setOpacity()
- setProperty()
- transformColor()
Parameters
parameter DEFAULTENCLOSINGCLASS = dslegendDiv;
Inherited description: Subclasses can set this to change default enclosingClass used for this
component.
parameter DOMAIN = %DeepSee;
Localization domain
parameter NAMESPACE = http://www.intersystems.com/deepsee;
Inherited description: 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.
Note: if this component is placed within a composite element, then the chart must be within the same composite element.
Property methods: chartIdDisplayToLogical(), chartIdGet(), chartIdIsValid(), chartIdLogicalToDisplay(), chartIdLogicalToOdbc(), chartIdNormalize(), chartIdSet()
property legendBorderStyle as %ZEN.Datatype.style;
Style to apply to border lines in the legend.
Property methods: legendBorderStyleDisplayToLogical(), legendBorderStyleGet(), legendBorderStyleIsValid(), legendBorderStyleLogicalToDisplay(), legendBorderStyleLogicalToOdbc(), legendBorderStyleNormalize(), legendBorderStyleSet()
property legendBoxStyle as %ZEN.Datatype.style;
Style to apply to the legendBox
Property methods: legendBoxStyleDisplayToLogical(), legendBoxStyleGet(), legendBoxStyleIsValid(), legendBoxStyleLogicalToDisplay(), legendBoxStyleLogicalToOdbc(), legendBoxStyleNormalize(), legendBoxStyleSet()
property legendLabels as %ZEN.Datatype.csv (XMLPROJECTION = "none");
Store legend Labels here so available to UI.ChartPDF and Widget.pivot
Property methods: legendLabelsDisplayToLogical(), legendLabelsGet(), legendLabelsIsValid(), legendLabelsLogicalToDisplay(), legendLabelsLogicalToOdbc(), legendLabelsNormalize(), legendLabelsSet()
property legendPosition as %ZEN.Datatype.string (VALUELIST = "top,left,bottom,right,none", XMLPROJECTION = "none");
Remember the legend position.
Property methods: legendPositionDisplayToLogical(), legendPositionGet(), legendPositionIsValid(), legendPositionLogicalToDisplay(), legendPositionLogicalToOdbc(), legendPositionNormalize(), legendPositionSet()
property legendStyle as %ZEN.Datatype.style;
Style to apply to the legend table.
Property methods: legendStyleDisplayToLogical(), legendStyleGet(), legendStyleIsValid(), legendStyleLogicalToDisplay(), legendStyleLogicalToOdbc(), legendStyleNormalize(), legendStyleSet()
property legendTitle as %ZEN.Datatype.caption (XMLPROJECTION = "none");
Store legend title here so available to UI.ChartPDF and Widget.pivot
Property methods: legendTitleDisplayToLogical(), legendTitleGet(), legendTitleIsValid(), legendTitleLogicalToDisplay(), legendTitleLogicalToOdbc(), legendTitleNormalize(), legendTitleSet()
property orientation as %ZEN.Datatype.string (VALUELIST = "horizontal,vertical") [ InitialExpression = "vertical" ];
Specify which way the legend is layed out.
Property methods: orientationDisplayToLogical(), orientationGet(), orientationIsValid(), orientationLogicalToDisplay(), orientationLogicalToOdbc(), orientationNormalize(), orientationSet()
property showLegendTitle as %ZEN.Datatype.boolean (XMLPROJECTION = "none") [ InitialExpression = 1 ];
Property methods: showLegendTitleDisplayToLogical(), showLegendTitleGet(), showLegendTitleIsValid(), showLegendTitleLogicalToDisplay(), showLegendTitleLogicalToOdbc(), showLegendTitleLogicalToXSD(), showLegendTitleNormalize(), showLegendTitleSet(), showLegendTitleXSDToLogical()
Methods
method %DrawHTML()
Inherited description: 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.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView
has raised an event.
clientmethod parseStyleSVG(style) [ Language = javascript ]
Utility method. Split an SVG css value into individual style values.
Return an object containing these values.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render this control.
clientmethod setBorderStyle(borderStyleAttribute, value) [ Language = javascript ]
Insert a single style item into the multi-item legendBorderStyle
clientmethod setOpacity(opacity) [ Language = javascript ]
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod transformColor(color) [ Language = javascript ]
Some charts may have use SVG colors. This is a crude translator.
Inherited Members
Inherited Properties
- %condition
- %controller
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- composite
- containerStyle
- controller
- controllerId
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- height
- hidden
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelStyle
- name
- onafterdrag
- onbeforedrag
- ondrag
- ondrop
- onhide
- onnotifyView
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- valign
- visible
- width
- window
Inherited Methods
- %AddToSaveSet()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawComponentHTML()
- %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()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onStartModalHandler()
- onloadHandler()
- onunloadHandler()
- onupdateHandler()
- refreshContents()
- render()
- renderSVG()
- sendEventToController()
- setControllerId()
- setHidden()
- setOverlayMode()
- startProgressBar()
- stopProgressBar()