%DeepSee.Component.SVG.scoreCard

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

Property Inventory

Method Inventory

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;
Inherited description: 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;
Inherited description: 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 methods: arrowSizeDisplayToLogical(), arrowSizeGet(), arrowSizeIsValid(), arrowSizeLogicalToDisplay(), arrowSizeLogicalToOdbc(), arrowSizeNormalize(), arrowSizeSet()
property arrowStyle as %ZEN.Datatype.svgStyle;
Optional. Style to indicator arrows in plotBox.
Property methods: arrowStyleDisplayToLogical(), arrowStyleGet(), arrowStyleIsValid(), arrowStyleLogicalToDisplay(), arrowStyleLogicalToOdbc(), arrowStyleNormalize(), arrowStyleSet()
property cardHeight as %ZEN.Datatype.integer (XMLPROJECTION = "none", ZENSETTING = 0) [ InitialExpression = 0 ];
Computed height (pixels) of the scorecard.
Property methods: cardHeightDisplayToLogical(), cardHeightGet(), cardHeightIsValid(), cardHeightLogicalToDisplay(), cardHeightLogicalToOdbc(), cardHeightNormalize(), cardHeightSet()
property cardSize as %ZEN.Datatype.string;
How big to show items within this score card. This can be "big" or "" (regular).
Property methods: cardSizeDisplayToLogical(), cardSizeGet(), cardSizeIsValid(), cardSizeLogicalToDisplay(), cardSizeLogicalToOdbc(), cardSizeNormalize(), cardSizeSet()
property cellCaptionStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to cell captions.
Property methods: cellCaptionStyleDisplayToLogical(), cellCaptionStyleGet(), cellCaptionStyleIsValid(), cellCaptionStyleLogicalToDisplay(), cellCaptionStyleLogicalToOdbc(), cellCaptionStyleNormalize(), cellCaptionStyleSet()
property columnHeaderStyle as %ZEN.Datatype.svgStyle;
Optional. Style for column headers in plotBox.
Property methods: columnHeaderStyleDisplayToLogical(), columnHeaderStyleGet(), columnHeaderStyleIsValid(), columnHeaderStyleLogicalToDisplay(), columnHeaderStyleLogicalToOdbc(), columnHeaderStyleNormalize(), columnHeaderStyleSet()
property columns as list of scoreCardColumn (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Specification for columns within the scoreCard.
Property methods: columnsBuildValueArray(), columnsCollectionToDisplay(), columnsCollectionToOdbc(), columnsDisplayToCollection(), columnsGet(), columnsGetObject(), columnsGetObjectId(), columnsGetSwizzled(), columnsIsValid(), columnsOdbcToCollection(), columnsSet(), columnsSetObject(), columnsSetObjectId()
property footersVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Optional: if true, display column footers.
Property methods: footersVisibleDisplayToLogical(), footersVisibleGet(), footersVisibleIsValid(), footersVisibleLogicalToDisplay(), footersVisibleLogicalToOdbc(), footersVisibleLogicalToXSD(), footersVisibleNormalize(), footersVisibleSet(), footersVisibleXSDToLogical()
property headersVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Optional: if true, display column headers.
Property methods: headersVisibleDisplayToLogical(), headersVisibleGet(), headersVisibleIsValid(), headersVisibleLogicalToDisplay(), headersVisibleLogicalToOdbc(), headersVisibleLogicalToXSD(), headersVisibleNormalize(), headersVisibleSet(), headersVisibleXSDToLogical()
property lampColor as %ZEN.Datatype.string [ InitialExpression = "#80F080" ];
Optional. Color of indicator lamp.
Property methods: lampColorDisplayToLogical(), lampColorGet(), lampColorIsValid(), lampColorLogicalToDisplay(), lampColorLogicalToOdbc(), lampColorNegDisplayToLogical(), lampColorNegGet(), lampColorNegIsValid(), lampColorNegLogicalToDisplay(), lampColorNegLogicalToOdbc(), lampColorNegNormalize(), lampColorNegSet(), lampColorNormalize(), lampColorSet()
property lampColorNeg as %ZEN.Datatype.string [ InitialExpression = "#F08080" ];
Optional. Color of negative indicator lamp.
Property methods: lampColorNegDisplayToLogical(), lampColorNegGet(), lampColorNegIsValid(), lampColorNegLogicalToDisplay(), lampColorNegLogicalToOdbc(), lampColorNegNormalize(), lampColorNegSet()
property lampLabelStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to labels within lamps.
Property methods: lampLabelStyleDisplayToLogical(), lampLabelStyleGet(), lampLabelStyleIsValid(), lampLabelStyleLogicalToDisplay(), lampLabelStyleLogicalToOdbc(), lampLabelStyleNormalize(), lampLabelStyleSet()
property lampSize as %ZEN.Datatype.float [ InitialExpression = 0.6 ];
Optional. Radius (as a percentage between 0 and 1) of a lamp.
Property methods: lampSizeDisplayToLogical(), lampSizeGet(), lampSizeIsValid(), lampSizeLogicalToDisplay(), lampSizeLogicalToOdbc(), lampSizeNormalize(), lampSizeSet()
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 methods: onclickrowDisplayToLogical(), onclickrowGet(), onclickrowIsValid(), onclickrowLogicalToDisplay(), onclickrowLogicalToOdbc(), onclickrowNormalize(), onclickrowSet()
property pivotData as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, swap rows and columns within the data source for this scoreCard.
Property methods: pivotDataDisplayToLogical(), pivotDataGet(), pivotDataIsValid(), pivotDataLogicalToDisplay(), pivotDataLogicalToOdbc(), pivotDataLogicalToXSD(), pivotDataNormalize(), pivotDataSet(), pivotDataXSDToLogical()
property plotBoxHeight as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Height (as a percentage between 0 and 1) of a plot box.
Property methods: plotBoxHeightDisplayToLogical(), plotBoxHeightGet(), plotBoxHeightIsValid(), plotBoxHeightLogicalToDisplay(), plotBoxHeightLogicalToOdbc(), plotBoxHeightNormalize(), plotBoxHeightSet()
property plotBoxLowerStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to lower range rectangle in plotBox.
Property methods: plotBoxLowerStyleDisplayToLogical(), plotBoxLowerStyleGet(), plotBoxLowerStyleIsValid(), plotBoxLowerStyleLogicalToDisplay(), plotBoxLowerStyleLogicalToOdbc(), plotBoxLowerStyleNormalize(), plotBoxLowerStyleSet()
property plotBoxMidStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to mid range rectangle in plotBox.
Property methods: plotBoxMidStyleDisplayToLogical(), plotBoxMidStyleGet(), plotBoxMidStyleIsValid(), plotBoxMidStyleLogicalToDisplay(), plotBoxMidStyleLogicalToOdbc(), plotBoxMidStyleNormalize(), plotBoxMidStyleSet()
property plotBoxStyle as %ZEN.Datatype.svgStyle;
Optional. Style to apply to outer rectangle in plotBox.
Property methods: plotBoxStyleDisplayToLogical(), plotBoxStyleGet(), plotBoxStyleIsValid(), plotBoxStyleLogicalToDisplay(), plotBoxStyleLogicalToOdbc(), plotBoxStyleNormalize(), plotBoxStyleSet()
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 methods: plotBoxValueHeightDisplayToLogical(), plotBoxValueHeightGet(), plotBoxValueHeightIsValid(), plotBoxValueHeightLogicalToDisplay(), plotBoxValueHeightLogicalToOdbc(), plotBoxValueHeightNormalize(), plotBoxValueHeightSet()
property plotBoxValueStyle as %ZEN.Datatype.svgStyle [ InitialExpression = "fill:rgb(47,98,128);" ];
Optional. Style to apply to value bar in plotBox.
Property methods: plotBoxValueStyleDisplayToLogical(), plotBoxValueStyleGet(), plotBoxValueStyleIsValid(), plotBoxValueStyleLogicalToDisplay(), plotBoxValueStyleLogicalToOdbc(), plotBoxValueStyleNegDisplayToLogical(), plotBoxValueStyleNegGet(), plotBoxValueStyleNegIsValid(), plotBoxValueStyleNegLogicalToDisplay(), plotBoxValueStyleNegLogicalToOdbc(), plotBoxValueStyleNegNormalize(), plotBoxValueStyleNegSet(), plotBoxValueStyleNormalize(), plotBoxValueStyleSet()
property plotBoxValueStyleNeg as %ZEN.Datatype.svgStyle [ InitialExpression = "fill:rgb(128,47,47);" ];
Optional. Style to apply to negative value bar in plotBox.
Property methods: plotBoxValueStyleNegDisplayToLogical(), plotBoxValueStyleNegGet(), plotBoxValueStyleNegIsValid(), plotBoxValueStyleNegLogicalToDisplay(), plotBoxValueStyleNegLogicalToOdbc(), plotBoxValueStyleNegNormalize(), plotBoxValueStyleNegSet()
property rowHeight as %ZEN.Datatype.integer;
Height (pixels) of rows within the scorecard.
Property methods: rowHeightDisplayToLogical(), rowHeightGet(), rowHeightIsValid(), rowHeightLogicalToDisplay(), rowHeightLogicalToOdbc(), rowHeightNormalize(), rowHeightSet()
property selectedIndex as %ZEN.Datatype.integer [ InitialExpression = -1 ];
Index of selected row (0-based).
Property methods: selectedIndexDisplayToLogical(), selectedIndexGet(), selectedIndexIsValid(), selectedIndexLogicalToDisplay(), selectedIndexLogicalToOdbc(), selectedIndexNormalize(), selectedIndexSet()
property targetLineStyle as %ZEN.Datatype.svgStyle;
Optional. Style for targetLine in plotBox.
Property methods: targetLineStyleDisplayToLogical(), targetLineStyleGet(), targetLineStyleIsValid(), targetLineStyleLogicalToDisplay(), targetLineStyleLogicalToOdbc(), targetLineStyleNormalize(), targetLineStyleSet()
property titleAlign as %ZEN.Datatype.string (VALUELIST = ",center,left,right") [ InitialExpression = "left" ];
Optional: alignment for title and subtitle. (Default is left for scorecard).
Property methods: titleAlignDisplayToLogical(), titleAlignGet(), titleAlignIsValid(), titleAlignLogicalToDisplay(), titleAlignLogicalToOdbc(), titleAlignNormalize(), titleAlignSet()
property titleImage as %ZEN.Datatype.uri;
Optional: URL of image to display within the title area.
Property methods: titleImageDisplayToLogical(), titleImageGet(), titleImageIsValid(), titleImageLogicalToDisplay(), titleImageLogicalToOdbc(), titleImageNormalize(), titleImageSet(), titleImageStyleDisplayToLogical(), titleImageStyleGet(), titleImageStyleIsValid(), titleImageStyleLogicalToDisplay(), titleImageStyleLogicalToOdbc(), titleImageStyleNormalize(), titleImageStyleSet()
property titleImageStyle as %ZEN.Datatype.svgStyle;
Optional. Style for titleImage: left,top,width, and height.
Property methods: titleImageStyleDisplayToLogical(), titleImageStyleGet(), titleImageStyleIsValid(), titleImageStyleLogicalToDisplay(), titleImageStyleLogicalToOdbc(), titleImageStyleNormalize(), titleImageStyleSet()
property titleVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Optional: if true, display the title area.
Property methods: titleVisibleDisplayToLogical(), titleVisibleGet(), titleVisibleIsValid(), titleVisibleLogicalToDisplay(), titleVisibleLogicalToOdbc(), titleVisibleLogicalToXSD(), titleVisibleNormalize(), titleVisibleSet(), titleVisibleXSDToLogical()
property trendBarsHeight as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Height (as a percentage between 0 and 1) of a trend bar chart.
Property methods: trendBarsHeightDisplayToLogical(), trendBarsHeightGet(), trendBarsHeightIsValid(), trendBarsHeightLogicalToDisplay(), trendBarsHeightLogicalToOdbc(), trendBarsHeightNormalize(), trendBarsHeightSet()
property trendBarsStyle as %ZEN.Datatype.svgStyle;
Optional. Style for trendBars in plotBox.
Property methods: trendBarsStyleDisplayToLogical(), trendBarsStyleGet(), trendBarsStyleIsValid(), trendBarsStyleLogicalToDisplay(), trendBarsStyleLogicalToOdbc(), trendBarsStyleNormalize(), trendBarsStyleSet()
property trendLineHeight as %ZEN.Datatype.float [ InitialExpression = 0.8 ];
Optional. Height (as a percentage between 0 and 1) of a trend line.
Property methods: trendLineHeightDisplayToLogical(), trendLineHeightGet(), trendLineHeightIsValid(), trendLineHeightLogicalToDisplay(), trendLineHeightLogicalToOdbc(), trendLineHeightNormalize(), trendLineHeightSet()
property trendLineStyle as %ZEN.Datatype.svgStyle;
Optional. Style for trendLine in plotBox.
Property methods: trendLineStyleDisplayToLogical(), trendLineStyleGet(), trendLineStyleIsValid(), trendLineStyleLogicalToDisplay(), trendLineStyleLogicalToOdbc(), trendLineStyleNormalize(), trendLineStyleSet()

Methods

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.
clientmethod getRowValue(row) [ Language = javascript ]
Return the logical value associated with the given row (0-based).
clientmethod hasAxes() [ Language = javascript ]
No axes for a score card.
clientmethod lookup(key) [ Language = javascript ]
Lookup function for formula engine.
clientmethod renderContents() [ Language = javascript ]
Render the inner SVG contents of this component.
clientmethod renderScoreCard() [ Language = javascript ]
Render the contents of this component.
clientmethod rowClickHandler(evt, row) [ Language = javascript ]
Row click handler.
clientmethod selectRow(row) [ Language = javascript ]
Select the given row.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties

Inherited Methods

Feedback