Skip to main content

%DeepSee.Component.SVG.scoreCard

Class %DeepSee.Component.SVG.scoreCard Extends %ZEN.SVGComponent.chart [ System = 4 ]

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).

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/deepsee";

INCLUDEFILES​

Parameter INCLUDEFILES = "dsparser.js";

DEFAULTVIEWBOXWIDTH;​

Parameter DEFAULTVIEWBOXWIDTH;

Default viewBoxWidth of this component. Turn off for score card.

DEFAULTVIEWBOXHEIGHT;​

Parameter DEFAULTVIEWBOXHEIGHT;

Default viewBoxHeight of this component.

DOMAIN​

Parameter DOMAIN = "%DeepSee";

Localization domain

Properties​

columns​

Property columns As list Of scoreCardColumn(XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);

Specification for columns within the scoreCard.

cardSize​

Property cardSize As %ZEN.Datatype.string;

How big to show items within this score card. This can be "big" or "" (regular).

rowHeight​

Property rowHeight As %ZEN.Datatype.integer;

Height (pixels) of rows within the scorecard.

cardHeight​

Property cardHeight As %ZEN.Datatype.integer(XMLPROJECTION = "none", ZENSETTING = 0) [ InitialExpression = 0 ];

Computed height (pixels) of the scorecard.

selectedIndex​

Property selectedIndex As %ZEN.Datatype.integer [ InitialExpression = -1 ];

Index of selected row (0-based).

plotBoxStyle​

Property plotBoxStyle As %ZEN.Datatype.svgStyle;

Optional. Style to apply to outer rectangle in plotBox.

cellCaptionStyle​

Property cellCaptionStyle As %ZEN.Datatype.svgStyle;

Optional. Style to apply to cell captions.

lampLabelStyle​

Property lampLabelStyle As %ZEN.Datatype.svgStyle;

Optional. Style to apply to labels within lamps.

lampSize​

Property lampSize As %ZEN.Datatype.float [ InitialExpression = 0.6 ];

Optional. Radius (as a percentage between 0 and 1) of a lamp.

arrowSize​

Property arrowSize As %ZEN.Datatype.float [ InitialExpression = 0.8 ];

Optional. Size (as a percentage between 0 and 1) of an arrow.

plotBoxHeight​

Property plotBoxHeight As %ZEN.Datatype.float [ InitialExpression = 0.8 ];

Optional. Height (as a percentage between 0 and 1) of a plot box.

plotBoxValueHeight​

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.

plotBoxValueStyle​

Property plotBoxValueStyle As %ZEN.Datatype.svgStyle [ InitialExpression = "fill:rgb(47,98,128);" ];

Optional. Style to apply to value bar in plotBox.

plotBoxValueStyleNeg​

Property plotBoxValueStyleNeg As %ZEN.Datatype.svgStyle [ InitialExpression = "fill:rgb(128,47,47);" ];

Optional. Style to apply to negative value bar in plotBox.

plotBoxLowerStyle​

Property plotBoxLowerStyle As %ZEN.Datatype.svgStyle;

Optional. Style to apply to lower range rectangle in plotBox.

plotBoxMidStyle​

Property plotBoxMidStyle As %ZEN.Datatype.svgStyle;

Optional. Style to apply to mid range rectangle in plotBox.

arrowStyle​

Property arrowStyle As %ZEN.Datatype.svgStyle;

Optional. Style to indicator arrows in plotBox.

lampColor​

Property lampColor As %ZEN.Datatype.string [ InitialExpression = "#80F080" ];

Optional. Color of indicator lamp.

lampColorNeg​

Property lampColorNeg As %ZEN.Datatype.string [ InitialExpression = "#F08080" ];

Optional. Color of negative indicator lamp.

trendLineStyle​

Property trendLineStyle As %ZEN.Datatype.svgStyle;

Optional. Style for trendLine in plotBox.

trendLineHeight​

Property trendLineHeight As %ZEN.Datatype.float [ InitialExpression = 0.8 ];

Optional. Height (as a percentage between 0 and 1) of a trend line.

trendBarsStyle​

Property trendBarsStyle As %ZEN.Datatype.svgStyle;

Optional. Style for trendBars in plotBox.

trendBarsHeight​

Property trendBarsHeight As %ZEN.Datatype.float [ InitialExpression = 0.8 ];

Optional. Height (as a percentage between 0 and 1) of a trend bar chart.

columnHeaderStyle​

Property columnHeaderStyle As %ZEN.Datatype.svgStyle;

Optional. Style for column headers in plotBox.

targetLineStyle​

Property targetLineStyle As %ZEN.Datatype.svgStyle;

Optional. Style for targetLine in plotBox.

pivotData​

Property pivotData As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, swap rows and columns within the data source for this scoreCard.

onclickrow​

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.

titleAlign​

Property titleAlign As %ZEN.Datatype.string(VALUELIST = ",center,left,right") [ InitialExpression = "left" ];

Optional: alignment for title and subtitle. (Default is left for scorecard).

titleVisible​

Property titleVisible As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Optional: if true, display the title area.

headersVisible​

Property headersVisible As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Optional: if true, display column headers.

footersVisible​

Property footersVisible As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Optional: if true, display column footers.

titleImage​

Property titleImage As %ZEN.Datatype.uri;

Optional: URL of image to display within the title area.

titleImageStyle​

Property titleImageStyle As %ZEN.Datatype.svgStyle;

Optional. Style for titleImage: left,top,width, and height.

XDatas​

SVGStyle​

XData SVGStyle

Methods​

hasAxes​

ClientMethod hasAxes() [ Language = javascript ]

No axes for a score card.

renderContents​

ClientMethod renderContents() [ Language = javascript ]

Render the inner SVG contents of this component.

renderScoreCard​

ClientMethod renderScoreCard() [ Language = javascript ]

Render the contents of this component.

getPropName​

ClientMethod getPropName(prop) [ Internal, Language = javascript ]

Given a column property, see if it is a property name and return it. Otherwise return '';

getMaxValue​

ClientMethod getMaxValue(args) [ Internal, Language = javascript ]

Implentation of max() function within formulae. Return max value of given property within current data set. or max of values within a list of items.

getMinValue​

ClientMethod getMinValue(args) [ Internal, Language = javascript ]

Implentation of min() function within formulae. Return min value of given property within current data set.

getCountValue​

ClientMethod getCountValue(args) [ Internal, Language = javascript ]

Implentation of count() function within formulae. Return count of items within current data set.

getAvgValue​

ClientMethod getAvgValue(args) [ Internal, Language = javascript ]

Implentation of avg() function within formulae. Return average of items within current data set.

getSumValue​

ClientMethod getSumValue(args) [ Internal, Language = javascript ]

Implentation of sum() function within formulae. Return sum of items within current data set.

evaluate​

ClientMethod 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.

lookup​

ClientMethod lookup(key) [ Language = javascript ]

Lookup function for formula engine.

setProperty​

ClientMethod setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

rowClickHandler​

ClientMethod rowClickHandler(evt, row) [ Language = javascript ]

Row click handler.

getRowValue​

ClientMethod getRowValue(row) [ Language = javascript ]

Return the logical value associated with the given row (0-based).

selectRow​

ClientMethod selectRow(row) [ Language = javascript ]

Select the given row.