Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [SVGComponent] >  [swirlChart]
Private  Storage   

deprecatedclass %ZEN.SVGComponent.swirlChart extends %ZEN.SVGComponent.chart

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 11


Summary

Properties
%condition %controller %import %includeFiles
%page %resource animate appearance
autoScaleText aux axisLineStyle axisTitleStyle
backgroundStyle bandLower bandLowerStyle bandUpper
bandUpperStyle baseLineStyle borderOffset borderRadius
borderStyle boundless composite controller
controllerId currYAxis document endTime
gap gridStyle hasZoom height
hidden id index indicatorStyle
indicatorsVisible invert labelStyle labelsVisible
legendHeight legendLabelStyle legendRectStyle legendStyle
legendTitle legendVisible legendWidth legendX
legendY lineStyle marginBottom marginLeft
marginRight marginTop markerScale markerShapes
markerStyle markersVisible maxLabelLen msgIfNoData
multipleTitleStyle name noDataFill noDataOpacity
noDataStroke onclick onelementClick ongetData
ongetLabelX ongetLabelY ongetSeriesColor ongetTimeEvents
onnotifyView onrenderData onrenderPlotArea onshowTooltip
onupdate parent plotAreaStyle plotBy
plotEdgeStyle plotStyle plotToEdge position
preserveAspectRatio scrollButtonStyle selectedItem selectedItemStyle
selectedSeries separateSeriesScale seriesColorScheme seriesColors
seriesColorsOverride seriesCount seriesNames seriesNumber
seriesSize seriesYAxes showMultiples startTime
stripeStyle stripesVisible subtitle subtitleStyle
svgComponent svgGroup textSize timeBased
title titleAlign titleBoxStyle titleImage
titleImageStyle titleStyle titleX titleY
tooltipRectStyle tuple unselectedItemStyle valueBoxStyle
valueLabelFormat valueLabelStyle valueLabelsVisible viewBoxHeight
viewBoxWidth visible warnIfNoData width
window x xAxis y
yAxis yAxisList

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawHTML %DrawJSStrings %Eval
%EvalC %Extends %ForceClientRender %GetEventHandlers
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType adjustChartTitle beginWaitState
calculateAxisConstraints calculateViewBox calculateXAxisHeight calculateXAxisTitleHeight
calculateYAxisWidth chartElementClickHandler clickHandler computeEffectiveExtents
computeStyle computeXAxisTimeLine createMarker createSVGTextNode
createXLabelNode embedStyle endWaitState findElement
findSVGElement fireOnUpdateEvent formatNumeric getChartElement
getChartElementStyle getChartRelatedElements getChartSubtitle getChartTitle
getColorSchemeArray getComputedFontSize getController getCurrYAxis
getEndTime getFrame getLegendLabels getLegendRectStyle
getLegendsCount getMarkerShape getNumericAbbreviation getPelToPixelHRatio
getPelToPixelVRatio getPlotX getPlotY getProperty
getRangeGroupForSeries getRelatedElementStyle getSelectedItem getSelectedSeries
getSelectedStyle getSeriesColor getSeriesCount getSeriesData
getSeriesNames getSeriesNamesSize getSeriesSVGGroup getSeriesSize
getSeriesType getSettings getSizeAbsolute getStartTime
getTimeX getType getXAxis getXAxisTitle
getXAxisType getXLabelText getYAxis getYAxisCount
getYAxisIndexForSeries getYAxisTitle getYAxisType getYLabelText
hasAxes hasMultiples hasSelectedItem initializeAxisProperties
integrateStyleSpec invokeSuper is3D isOfType
isTimeBased makeId notifyViewHandler onCreate
onDelete onSerialize onloadHandler onunloadHandler
onupdateHandler parseStyleSVG pickVerticalSkips plotLineForSeries
prepareAxisGroup refreshContents removeChildNodes removeNoDataMsg
render renderAxes renderBands renderContents
renderLegend renderPlotArea renderSVG renderSeries
renderSeriesGroup renderTimeEvents renderTitle renderXAxisTimeLine
renderXAxisTitle renderXLabels renderYAxisTitle renderYLabels
selectElement sendEventToController setAnimation setControllerId
setCurrYAxis setDimToolTip setOverlayMode setPosition
setPositionHandler setProperty setSeeThrough setSize
setSizeHandler setTextNode setTimeRange setXAxis
setYAxis showNoDataMsg sizingMouseDownHandler stripWhitespace
unrender updateChart updateIndicator usePercentForRange
useSumForRange wrapMethod xToLogical yToLogical


Properties

• property animate as %ZEN.Datatype.string(VALUELIST=",none,auto,manual") [ InitialExpression = "auto" ];
when drawing start, draw slices and labels in an animation or just show finished product
• property gap as %ZEN.Datatype.integer(MAXVAL=135,MINVAL=0) [ InitialExpression = 30 ];
space between first slice and last slice in degrees
• property invert as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Whether or not to 'invert' the swirl. In an inverted swirl, the labels are on the outside and the slices are lines rather than real surfaces.
Note, that the invert property is only active when labels are visible (labelsVisible=true)
• property legendVisible as %ZEN.Datatype.string(VALUELIST=",auto,false,true") [ InitialExpression = "false" ];
Overriding default value: now FALSE
• property plotBy as %ZEN.Datatype.string(VALUELIST=",items,series") [ InitialExpression = "items" ];
plotBy - items - this is default, it results in slices that are colored by items and a legend that is organized by labels on the slices
plotBy - series - it results in slices where slices of the same series are the same color, and legend shows labels for each series (not labels on the slices)
• property separateSeriesScale as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Methods

• method getChartElementStyle(series, item) [ Language = javascript ]
Return default style for the specified data element (if any). This is used to restore styles when chart elements are unselected. Subclasses can override this.
• method getLegendLabels() [ Language = javascript ]
Return an array of labels to display within the Legend box.
Default implementation is to return a list of series names.
• method getLegendsCount(legends) [ Language = javascript ]
• method getSeriesNamesSize() [ Language = javascript ]
• method getYLabelText(val, yAxisNo, base) [ Language = javascript ]
Given a logical value, return the text to use for an axis label. base is an arbitrary delta but can be used to make labels 0-based or 1-based default is 0-based for backwards compatibility Can be overriden by user through sub-classing
• method hasAxes() [ Language = javascript ]
Indicates that this chart has no axes and associated grids
• method hasMultiples() [ Language = javascript ]
Indicates that this chart supports "show multiples" mode.
• method is3D() [ Language = javascript ]
Do not show 3-D plot area.
• method renderSeries(group) [ Language = javascript ]
Draw data series for this chart. group is the SVG container for the chart components.
• method setAnimation(label, steps, from, to, center) [ Language = javascript ]
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.


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