%ZEN.SVGComponent.treeMapChart
class %ZEN.SVGComponent.treeMapChart extends %ZEN.SVGComponent.chart
This is an SVG chart component that displays a tree map.A tree map displays a series of values as a set of rectangles. The area of each rectangle is proportional to its value. Negative values are ignored.
Property Inventory
Method Inventory
- convertToRGB()
- getChartElementStyle()
- getFGColor()
- getLegendLabels()
- getSeriesColor()
- hasAxes()
- hasMultiples()
- is3D()
- plotItems()
- plotOneBox()
- renderSeries()
- setProperty()
Properties
property ongetColorScaleData as %ZEN.Datatype.eventHandler;
ongetColorScaleData event handler:
This event handler, if defined, is called by the chart to compute the color scale
for a given data item. It should match the format of ongetData(),
returning corresponding color scale values for each data point returned by
ongetData(). For example, to scale the colors of each data point
according to the "value" of that data point itself, set this property to the
same event handler as ongetData().
The scaled colors will be using the first color defined in
seriesColorScheme, optionally overridden by
seriesColors.
Property methods: ongetColorScaleDataDisplayToLogical(), ongetColorScaleDataGet(), ongetColorScaleDataIsValid(), ongetColorScaleDataLogicalToDisplay(), ongetColorScaleDataLogicalToOdbc(), ongetColorScaleDataNormalize(), ongetColorScaleDataSet()
property showPercentage as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, percentage values (rounded to 2 decimal places integer) are displayed as
part of the label for each box.
Property methods: showPercentageDisplayToLogical(), showPercentageGet(), showPercentageIsValid(), showPercentageLogicalToDisplay(), showPercentageLogicalToOdbc(), showPercentageLogicalToXSD(), showPercentageNormalize(), showPercentageSet(), showPercentageXSDToLogical()
Methods
clientmethod convertToRGB(string) [ Language = javascript ]
Returns a 3-element array containing the RGB values for the string input.
Supporte inputs:
- RGB format: fe 'rgb(123,45,67)' => { 123, 45, 67 }
- HEX format, with or without leading #: fe '#ff0000' => { 255, 0, 0 }
- predefined CSS colors: fe 'white' => { 255, 255, 255 }
Throws a simple string error message if unsupported input is being supplied (such as "url(#glow-red)")
clientmethod getChartElementStyle(series, item) [ Language = javascript ]
Return default style for slice element.
clientmethod getFGColor(background) [ Language = javascript ]
Based on the supplied background color, return an appropriately contrasting foreground
color (for text labels). Currently, returns either black or white based on background
brightness
clientmethod getLegendLabels() [ Language = javascript ]
Return an array of labels to display within the Legend box.
Override to get appropriate labels for TreeMap Chart.
Override to get appropriate labels for TreeMap Chart.
clientmethod getSeriesColor(index, series, itemNo) [ Language = javascript ]
Return the CSS color that should be used for the given series.
clientmethod hasAxes() [ Language = javascript ]
Indicates that this chart has no axes and associated grids
clientmethod hasMultiples() [ Language = javascript ]
Indicates that this chart supports "show multiples" mode.
clientmethod is3D() [ Language = javascript ]
Do not show 3-D plot area.
clientmethod plotItems(group, dataItems, width, height, x, y, qCount, seriesNumber) [ Language = javascript ]
Plot map items onto the chart.
clientmethod plotOneBox(group, seriesNo, itemNo, x, y, width, height, value) [ Language = javascript ]
Render one item in the chart.
clientmethod renderSeries(group) [ Language = javascript ]
Draw data series for this chart.
group is the SVG container for the chart components.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
Inherited Members
Inherited Properties
- %condition
- %controller
- %import
- %includeFiles
- %page
- %resource
- appearance
- autoScaleText
- aux
- axisLineStyle
- axisTitleStyle
- backgroundStyle
- bandLower
- bandLowerStyle
- bandUpper
- bandUpperStyle
- baseLineStyle
- borderOffset
- borderRadius
- borderStyle
- boundless
- composite
- controller
- controllerId
- currYAxis
- document
- endTime
- gridStyle
- hasZoom
- height
- hidden
- id
- index
- indicatorStyle
- indicatorsVisible
- 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
- plotEdgeStyle
- plotStyle
- plotToEdge
- position
- preserveAspectRatio
- scrollButtonStyle
- selectedItem
- selectedItemStyle
- selectedSeries
- 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
Inherited 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()
- getChartRelatedElements()
- getChartSubtitle()
- getChartTitle()
- getColorSchemeArray()
- getComputedFontSize()
- getController()
- getCurrYAxis()
- getEndTime()
- getFrame()
- getLegendRectStyle()
- getLegendsCount()
- getMarkerShape()
- getNumericAbbreviation()
- getPelToPixelHRatio()
- getPelToPixelVRatio()
- getPlotX()
- getPlotY()
- getProperty()
- getRangeGroupForSeries()
- getRelatedElementStyle()
- getSelectedItem()
- getSelectedSeries()
- getSelectedStyle()
- getSeriesCount()
- getSeriesData()
- getSeriesNames()
- getSeriesNamesSize()
- getSeriesSVGGroup()
- getSeriesSize()
- getSeriesType()
- getSettings()
- getSizeAbsolute()
- getStartTime()
- getTimeX()
- getType()
- getXAxis()
- getXAxisTitle()
- getXAxisType()
- getXLabelText()
- getYAxis()
- getYAxisCount()
- getYAxisIndexForSeries()
- getYAxisTitle()
- getYAxisType()
- getYLabelText()
- hasSelectedItem()
- initializeAxisProperties()
- integrateStyleSpec()
- invokeSuper()
- isOfType()
- isTimeBased()
- makeId()
- notifyViewHandler()
- onCreate()
- onDelete()
- onSerialize()
- onloadHandler()
- onunloadHandler()
- onupdateHandler()
- parseStyleSVG()
- pickVerticalSkips()
- plotLineForSeries()
- prepareAxisGroup()
- refreshContents()
- removeChildNodes()
- removeNoDataMsg()
- render()
- renderAxes()
- renderBands()
- renderContents()
- renderLegend()
- renderPlotArea()
- renderSVG()
- renderSeriesGroup()
- renderTimeEvents()
- renderTitle()
- renderXAxisTimeLine()
- renderXAxisTitle()
- renderXLabels()
- renderYAxisTitle()
- renderYLabels()
- selectElement()
- sendEventToController()
- setControllerId()
- setCurrYAxis()
- setDimToolTip()
- setOverlayMode()
- setPosition()
- setPositionHandler()
- setSeeThrough()
- setSize()
- setSizeHandler()
- setTextNode()
- setTimeRange()
- setXAxis()
- setYAxis()
- showNoDataMsg()
- sizingMouseDownHandler()
- stripWhitespace()
- unrender()
- updateChart()
- updateIndicator()
- usePercentForRange()
- useSumForRange()
- wrapMethod()
- xToLogical()
- yToLogical()