Class Reference
%DeepSee.Component.SVG.scoreCard
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%DeepSee] >  [Component] >  [SVG] >  [scoreCard]
Private  Storage

class %DeepSee.Component.SVG.scoreCard extends %ZEN.SVGComponent.chart

DeepSee score card component. This is a subclass of chart as it shares the same data acquisition logic (and uses many of the same style properties).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 33 15


Summary

Properties
%condition %controller %import %includeFiles
%page %resource appearance arrowSize
arrowStyle autoScaleText aux axisLineStyle
axisTitleStyle backgroundStyle bandLower bandLowerStyle
bandUpper bandUpperStyle baseLineStyle borderOffset
borderRadius borderStyle boundless cardHeight
cardSize cellCaptionStyle columnHeaderStyle columns
composite controller controllerId currYAxis
document endTime footersVisible gridStyle
hasZoom headersVisible height hidden
id index indicatorStyle indicatorsVisible
labelStyle labelsVisible lampColor lampColorNeg
lampLabelStyle lampSize 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
onclickrow onelementClick ongetData ongetLabelX
ongetLabelY ongetSeriesColor ongetTimeEvents onnotifyView
onrenderData onrenderPlotArea onshowTooltip onupdate
parent pivotData plotAreaStyle plotBoxHeight
plotBoxLowerStyle plotBoxMidStyle plotBoxStyle plotBoxValueHeight
plotBoxValueStyle plotBoxValueStyleNeg plotEdgeStyle plotStyle
plotToEdge position preserveAspectRatio rowHeight
scrollButtonStyle selectedIndex selectedItem selectedItemStyle
selectedSeries seriesColorScheme seriesColors seriesColorsOverride
seriesCount seriesNames seriesNumber seriesSize
seriesYAxes showMultiples startTime stripeStyle
stripesVisible subtitle subtitleStyle svgComponent
svgGroup targetLineStyle textSize timeBased
title titleAlign titleBoxStyle titleImage
titleImageStyle titleStyle titleVisible titleX
titleY tooltipRectStyle trendBarsHeight trendBarsStyle
trendLineHeight trendLineStyle 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 evaluate
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 getRowValue
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 lookup
makeId notifyViewHandler onCreate onDelete
onSerialize onloadHandler onunloadHandler onupdateHandler
parseStyleSVG pickVerticalSkips plotLineForSeries prepareAxisGroup
refreshContents removeChildNodes removeNoDataMsg render
renderAxes renderBands renderContents renderLegend
renderPlotArea renderSVG renderScoreCard renderSeries
renderSeriesGroup renderTimeEvents renderTitle renderXAxisTimeLine
renderXAxisTitle renderXLabels renderYAxisTitle renderYLabels
rowClickHandler selectElement selectRow sendEventToController
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


Parameters

• parameter DEFAULTVIEWBOXHEIGHT;
Default viewBoxHeight of this component.
• parameter DEFAULTVIEWBOXWIDTH;
Default viewBoxWidth of this component. Turn off for score card.
• parameter DOMAIN = "%DeepSee";
Localization domain
• parameter INCLUDEFILES = "dsparser.js";
CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.
• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties

• property arrowSize as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Size (as a percentage between 0 and 1) of an arrow.
• property arrowStyle as %ZEN.Datatype.svgStyle;
Optional. Style to indicator arrows in plotBox.
• property cardHeight as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
Computed height (pixels) of the scorecard.
• property cardSize as %ZEN.Datatype.string;
How big to show items within this score card. This can be "big" or "" (regular).
• property cellCaptionStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to cell captions.
• property columnHeaderStyle as %ZEN.Datatype.svgStyle;
Optional. Style for column headers in plotBox.
• property columns as list of scoreCardColumn(XMLPROJECTION="ELEMENT",XMLREF=1,XMLTYPECONSTRAINT="CHOICE",ZENSETTING=0);
Specification for columns within the scoreCard.
• property footersVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Optional: if true, display column footers.
• property headersVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Optional: if true, display column headers.
• property lampColor as %ZEN.Datatype.string [ InitialExpression = "#80F080" ];
Optional. Color of indicator lamp.
• property lampColorNeg as %ZEN.Datatype.string [ InitialExpression = "#F08080" ];
Optional. Color of negative indicator lamp.
• property lampLabelStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to labels within lamps.
• property lampSize as %ZEN.Datatype.float [ InitialExpression = 0.6 ];
Optional. Radius (as a percentage between 0 and 1) of a lamp.
• property onclickrow as %ZEN.Datatype.eventHandler;
onclickrow event handler: If defined, this event is fired when the user clicks on a row within the score card.
• property pivotData as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, swap rows and columns within the data source for this scoreCard.
• property plotBoxHeight as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Height (as a percentage between 0 and 1) of a plot box.
• property plotBoxLowerStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to lower range rectangle in plotBox.
• property plotBoxMidStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to mid range rectangle in plotBox.
• property plotBoxStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to outer rectangle in plotBox.
• property plotBoxValueHeight as %ZEN.Datatype.float [ InitialExpression = 0.5 ];
Optional. Height (as a percentage between 0 and 1) of the value bar within a plot box.
• property plotBoxValueStyle as %ZEN.Datatype.svgStyle [ InitialExpression = "fill:rgb(47,98,128);" ];
Optional. Style to apply to value bar in plotBox.
• property plotBoxValueStyleNeg as %ZEN.Datatype.svgStyle [ InitialExpression = "fill:rgb(128,47,47);" ];
Optional. Style to apply to negative value bar in plotBox.
• property rowHeight as %ZEN.Datatype.integer;
Height (pixels) of rows within the scorecard.
• property selectedIndex as %ZEN.Datatype.integer [ InitialExpression = -1 ];
Index of selected row (0-based).
• property targetLineStyle as %ZEN.Datatype.svgStyle;
Optional. Style for targetLine in plotBox.
• property titleAlign as %ZEN.Datatype.string(VALUELIST=",center,left,right") [ InitialExpression = "left" ];
Optional: alignment for title and subtitle. (Default is left for scorecard).
• property titleImage as %ZEN.Datatype.uri;
Optional: URL of image to display within the title area.
• property titleImageStyle as %ZEN.Datatype.svgStyle;
Optional. Style for titleImage: left,top,width, and height.
• property titleVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Optional: if true, display the title area.
• property trendBarsHeight as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Height (as a percentage between 0 and 1) of a trend bar chart.
• property trendBarsStyle as %ZEN.Datatype.svgStyle;
Optional. Style for trendBars in plotBox.
• property trendLineHeight as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Height (as a percentage between 0 and 1) of a trend line.
• property trendLineStyle as %ZEN.Datatype.svgStyle;
Optional. Style for trendLine in plotBox.

Methods

• method evaluate(expr, data, r) [ Language = javascript ]
Evaluate a value expression. expr is the expression; data is an array of data values subscripted by name and row; r is the row.
• method getRowValue(row) [ Language = javascript ]
Return the logical value associated with the given row (0-based).
• method hasAxes() [ Language = javascript ]
No axes for a score card.
• method lookup(key) [ Language = javascript ]
Lookup function for formula engine.
• method renderContents() [ Language = javascript ]
Render the inner SVG contents of this component.
• method renderScoreCard() [ Language = javascript ]
Render the contents of this component.
• method rowClickHandler(evt, row) [ Language = javascript ]
Row click handler.
• method selectRow(row) [ Language = javascript ]
Select the given row.
• 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.