public class

ReportGraphTransformImpl

extends AbstractReportDataTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
             ↳ com.microstrategy.web.app.transforms.AbstractReportDataTransform
               ↳ com.microstrategy.web.app.transforms.ReportGraphTransformImpl
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Provides a graph view to the report bean.

Summary

Nested Classes
class ReportGraphTransformImpl.GraphAreaContext  
Constants
String FP_HELP_TOPIC Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor
String FP_HELP_TYPE Constant specifying the type of the help file this editor should point to
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected ClientSideHelper _graphClientSideHelper
protected FormalParameter dropShadowDepth
protected FormalParameter graphHeight Graph Height to use.
protected FormalParameter graphImageFormat Graph Image Format to use.
protected FormalParameter graphSize Graph Size to use.
protected FormalParameter graphWidth Graph Width to use.
public FormalParameter helpTopic Indicates the help topic for the help page of the editor.
public FormalParameter helpType Indicates the type of help topic this editor uses.
protected FormalParameter imageSrc This is the name which specifies the source of the graph image.
protected FormalParameter isDisableGraphDrilling This is the flag used in the transform to specify whether to disable drilling on the graph
Allowed Values: TRUE/FALSE.
protected FormalParameter isGraphSrcAddSessionInfo This is the flag used in the transform to specify whether to include the session information on the image src of the graph
Allowed Values: TRUE/FALSE.
protected FormalParameter isGraphSrcFullPath This is the flag used in the transform to specify whether to include the full path on the image src of the graph
Allowed Values: TRUE/FALSE.
protected FormalParameter renderDropZones Indicates whether to render the graph drop zones.
protected FormalParameter showWidthHeightAttributes This flag is used to decide if we need to include the WIDTH and HEIGHT on the IMG tag.
protected FormalParameter shrinkGraphToHeight Graph height to shrink to if graph height is bigger than this value.
protected FormalParameter shrinkGraphToWidth Graph width to shrink to if graph width is bigger than this value.
protected FormalParameter useImageTag Whether to force the use of an "img" tag (instead of an "input" tag)
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportGraphTransformImpl()
default no-args constructor It created the formal parameters and assign default values to them.
Public Methods
Map getAttributesBone()
Map getAttributesGraph(boolean isLiveBone)
String getDescription()
Return description for this Transform.
Map getGraphBoneAttributes()
String getGraphData()
Get graph binary data and encode as base64.
boolean hasCenter()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean isContextMenusEnabled()
Checks privileges to determine whether the graph should enable context menus on the graph.
boolean isDesignMode()
This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
boolean isGraphAvailable()
void renderCenter(MarkupOutput out, ReportBean rb)
This method is deprecated. No replacement.
void renderData(MarkupOutput out, ReportBean rb)
This method is deprecated. No replacement.
void renderEmptyCase(MarkupOutput out, ReportBean rb)
This method is deprecated. No replacement.
void renderGraph(MarkupOutput out, ReportBean rb)
This method is deprecated. No replacement.
void renderGraph(MarkupOutput out)
Renders the graph bone, it's shell and sets all the javascript properties.
void renderGraphBone(MarkupOutput out)
Renders the javascript bone associated with the graph.
void renderGraphData(MarkupOutput out, ReportBean rb)
This method is deprecated. No replacement.
void renderGraphDropZones(MarkupOutput out)
Renders the graph drop zones editor.
void renderGraphError(MarkupOutput out)
Renders an error message on the graph page based on the kind of error it is.
void renderImageMap(MarkupOutput out)
Renders a map on top of the graph image for drilling, context menus etc.
void renderJavascript(MarkupOutput out)
This method renders the javascript code that needs to be generated on the server side because its content is dynamic.
void renderLayout(MarkupOutput out, ReportBean rb)
This method is deprecated. No replacement.
void renderRowsIncrementalFetch(MarkupOutput out)
Generates the rows incremental fetch portion.
void renderScroller(MarkupOutput out, int type)
Renders a scroller control that will allow the user to scroll across the chart's data.
Protected Methods
String getBoneId()
Returns the id to be used for the JavaScript bone.
TransformContext getContext()
Returns the instance of TransformContext with context information for this Transform.
String getContextMenuManagerName()
Returns the name of the Context Menu Manager assocaited with the graph.
WebEvent getDrillEvent()
GraphBean getGraphBean()
String getGraphBoneName()
ClientSideHelper getGraphClientSideHelper()
String getGraphHeight()
String getGraphSrc()
String getGraphTooltip()
String getGraphWidth()
String getImageId()
String getImageMapName()
WebEvent getLoadGraphEvent()
String getOnClickJS(WebDrillPath wdp)
WebEvent getRWDrillOutsideEvent()
boolean isDndEnabledForGraphs()
Returns, based on privileges, whether Drag and drop is available for the graph.
boolean isGraphAreaDrillingSupported()
Returns whether Drilling is enabled on the Graph Areas.
boolean isGraphTransform()
boolean isGridGraphMode()
boolean isGridTransform()
boolean isInvalidPageByError()
boolean isNoDataError()
boolean isNoTypesAvailableError()
void renderDropZonesCssLink(MarkupOutput out)
Renders the various CSS classes on the Graph Drop Zones Editor.
void renderGraphTypesError(MarkupOutput out)
Renders an error message when an exception is thrown when no graph types are available.
void renderInsufficientGraphDataError(MarkupOutput out)
Renders an error on the graph page when there's insufficient data available to render the graph.
void renderNoChartAvailable(MarkupOutput out)
Renders an error message on the graph page whenever there are no available graphs on the page.
void renderNoDataError(MarkupOutput out)
Renders an error on the Graph page when there's no data returned on the graph.
void renderPageByError(MarkupOutput out)
Renders an error on the graph page when there's an invalid page by condition/argument.
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boolean shouldRenderDropZones()
boolean shouldRenderGridInfo()
This method is used to determine if the bone's gridInfo structure needs to be included.
boolean showEmptyAxis()
boolean useDrillEvent()
boolean useRWDrillOutsideEvent()
boolean useViewModeGraphBone()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.app.transforms.ReportDataTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_HELP_TOPIC

Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor

Constant Value: "helpTopic"

public static final String FP_HELP_TYPE

Constant specifying the type of the help file this editor should point to

Constant Value: "helpType"

Fields

protected ClientSideHelper _graphClientSideHelper

protected FormalParameter dropShadowDepth

protected FormalParameter graphHeight

Graph Height to use.
It's applicable only if _graphSize is set to PreferencesGraphTransform.GRAPH_USE_USER_SIZE.
Allowed Values: integer values

protected FormalParameter graphImageFormat

Graph Image Format to use.
Allowed Values:
PreferencesGraphTransform.GRAPH_IMAGE_TYPE_REPORT
PreferencesGraphTransform.GRAPH_IMAGE_TYPE_GIF
PreferencesGraphTransform.GRAPH_IMAGE_TYPE_JPEG

protected FormalParameter graphSize

Graph Size to use.
Allowed Values:
PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE
PreferencesGraphTransform.GRAPH_USE_USER_SIZE

protected FormalParameter graphWidth

Graph Width to use.
It's applicable only if _graphSize is set to PreferencesGraphTransform.GRAPH_USE_USER_SIZE.
Allowed Values: integer values

public FormalParameter helpTopic

Indicates the help topic for the help page of the editor.

public FormalParameter helpType

Indicates the type of help topic this editor uses.

protected FormalParameter imageSrc

This is the name which specifies the source of the graph image.
Allowed Values: any file name used as the source of the graph image.

protected FormalParameter isDisableGraphDrilling

This is the flag used in the transform to specify whether to disable drilling on the graph
Allowed Values: TRUE/FALSE.

protected FormalParameter isGraphSrcAddSessionInfo

This is the flag used in the transform to specify whether to include the session information on the image src of the graph
Allowed Values: TRUE/FALSE.

protected FormalParameter isGraphSrcFullPath

This is the flag used in the transform to specify whether to include the full path on the image src of the graph
Allowed Values: TRUE/FALSE.

protected FormalParameter renderDropZones

Indicates whether to render the graph drop zones.
Usage:
This tells us how to decide whether to render the graph drop zones or not. Possible values for this property and their meaning include:

  • PREFERENCE_YES = Always display
  • PREFERENCE_NO = Never display
  • PREFERENCE_VALUE_FROM_REPORT = (default) Resolves programatically based on user preference and if the object browser is open

  • protected FormalParameter showWidthHeightAttributes

    This flag is used to decide if we need to include the WIDTH and HEIGHT on the IMG tag. (used for exporting to Excel).
    Allowed Values: TRUE/FALSE.

    protected FormalParameter shrinkGraphToHeight

    Graph height to shrink to if graph height is bigger than this value.
    If it's -1, it means not shrink at all. Allowed Values: integer values

    protected FormalParameter shrinkGraphToWidth

    Graph width to shrink to if graph width is bigger than this value.
    If it's -1, it means not shrink at all. Allowed Values: integer values

    protected FormalParameter useImageTag

    Whether to force the use of an "img" tag (instead of an "input" tag)

    Public Constructors

    public ReportGraphTransformImpl ()

    default no-args constructor It created the formal parameters and assign default values to them.

    Public Methods

    public Map getAttributesBone ()

    public Map getAttributesGraph (boolean isLiveBone)

    public String getDescription ()

    Return description for this Transform.

    Returns
    • The description as to what this Transform does.

    public Map getGraphBoneAttributes ()

    public String getGraphData ()

    Get graph binary data and encode as base64. Note: refer to {#link ReportGraphImageTransform.java }

    Returns
    • String base64-encoded image binary

    public boolean hasCenter ()

    This method is deprecated.
    This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

    Whether the transform has the center area. Out of box, it returns true.

    Returns
    • Whether the transform has the center area

    public boolean isContextMenusEnabled ()

    Checks privileges to determine whether the graph should enable context menus on the graph.

    Returns
    • boolean - True if context menus are enabled.

    public boolean isDesignMode ()

    This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.

    Returns
    • false by default. Any inherting class should override to implement its own version.

    public boolean isGraphAvailable ()

    public void renderCenter (MarkupOutput out, ReportBean rb)

    This method is deprecated.
    No replacement.

    Render center area of the transform.

    Parameters
    out output by this transform
    rb this report bean

    public void renderData (MarkupOutput out, ReportBean rb)

    This method is deprecated.
    No replacement.

    Render the report data area.
    For graph reports, it's the graph itself.

    Parameters
    out output by this transform
    rb this report bean

    public void renderEmptyCase (MarkupOutput out, ReportBean rb)

    This method is deprecated.
    No replacement.

    Render when the report grid is empty.
    Usually some information message is displayed.

    Parameters
    out output by this transform
    rb this report bean

    public void renderGraph (MarkupOutput out, ReportBean rb)

    This method is deprecated.
    No replacement.

    Renders the graph itself.
    Out of box, it's called from renderGraphData() method, but it can be used as a utility function.

    Parameters
    out output by this transform
    rb this report bean

    public void renderGraph (MarkupOutput out)

    Renders the graph bone, it's shell and sets all the javascript properties.

    public void renderGraphBone (MarkupOutput out)

    Renders the javascript bone associated with the graph.

    public void renderGraphData (MarkupOutput out, ReportBean rb)

    This method is deprecated.
    No replacement.

    Renders the graph.
    Out of box, it's called from renderData() method, but it can be used as a utility function.

    Parameters
    out output by this transform
    rb this report bean

    public void renderGraphDropZones (MarkupOutput out)

    Renders the graph drop zones editor. This editor helps in editing the graph by showing all the graph objects on their respective Rows, Series or Metrics columns.

    public void renderGraphError (MarkupOutput out)

    Renders an error message on the graph page based on the kind of error it is.

    public void renderImageMap (MarkupOutput out)

    Renders a map on top of the graph image for drilling, context menus etc.

    public void renderJavascript (MarkupOutput out)

    This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokes renderRegisterBone which initializes and registers a grid's bone..

    Parameters
    out MarkupOutput to generate the HTML.

    public void renderLayout (MarkupOutput out, ReportBean rb)

    This method is deprecated.
    No replacement.

    Render the layout for the report grid.
    Out of box, we don't render anything for the layout area for graph reports.

    Parameters
    out output by this transform
    rb this report bean

    public void renderRowsIncrementalFetch (MarkupOutput out)

    Generates the rows incremental fetch portion. It just delegates this to another Transform, as specified by the incrementalFetchStyleForRow formal parameter.

    Parameters
    out MarkupOutput to generate the HTML.

    public void renderScroller (MarkupOutput out, int type)

    Renders a scroller control that will allow the user to scroll across the chart's data.

    Parameters
    out MarkupOutput
    type int Type of scroller to render. Values from:
    Scroller.HORIZONTAL_SCROLLER
    Scroller.VERTICAL_SCROLLER

    Protected Methods

    protected String getBoneId ()

    Returns the id to be used for the JavaScript bone.
    This method is used by the renderRegisterBone method to indicate the id of the bone html element.

    Returns
    • String

    protected TransformContext getContext ()

    Returns the instance of TransformContext with context information for this Transform.

    protected String getContextMenuManagerName ()

    Returns the name of the Context Menu Manager assocaited with the graph.

    protected WebEvent getDrillEvent ()

    protected GraphBean getGraphBean ()

    protected String getGraphBoneName ()

    protected ClientSideHelper getGraphClientSideHelper ()

    protected String getGraphHeight ()

    protected String getGraphSrc ()

    protected String getGraphTooltip ()

    protected String getGraphWidth ()

    protected String getImageId ()

    protected String getImageMapName ()

    protected WebEvent getLoadGraphEvent ()

    protected String getOnClickJS (WebDrillPath wdp)

    protected WebEvent getRWDrillOutsideEvent ()

    protected boolean isDndEnabledForGraphs ()

    Returns, based on privileges, whether Drag and drop is available for the graph.

    Returns
    • True if the privileges are available.

    protected boolean isGraphAreaDrillingSupported ()

    Returns whether Drilling is enabled on the Graph Areas.

    protected boolean isGraphTransform ()

    protected boolean isGridGraphMode ()

    protected boolean isGridTransform ()

    protected boolean isInvalidPageByError ()

    protected boolean isNoDataError ()

    protected boolean isNoTypesAvailableError ()

    protected void renderDropZonesCssLink (MarkupOutput out)

    Renders the various CSS classes on the Graph Drop Zones Editor.

    protected void renderGraphTypesError (MarkupOutput out)

    Renders an error message when an exception is thrown when no graph types are available.

    Parameters
    out MarkupOutput

    protected void renderInsufficientGraphDataError (MarkupOutput out)

    Renders an error on the graph page when there's insufficient data available to render the graph.

    protected void renderNoChartAvailable (MarkupOutput out)

    Renders an error message on the graph page whenever there are no available graphs on the page. This error is also triggered wheneverthe property "Allow this report to be displayed as a graph" is unchecked.

    Parameters
    out MarkupOutput

    protected void renderNoDataError (MarkupOutput out)

    Renders an error on the Graph page when there's no data returned on the graph.

    protected void renderPageByError (MarkupOutput out)

    Renders an error on the graph page when there's an invalid page by condition/argument.

    protected void setBoneProperties (JsonGenerator boneProps)

    Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
    Usually called by renderRegisterBone(MarkupOutput)
    Can be overwritten to add or modify bone properties.

    Parameters
    boneProps the JsonGenerator object that contains the collection of bone properties.

    protected boolean shouldRenderDropZones ()

    protected boolean shouldRenderGridInfo ()

    This method is used to determine if the bone's gridInfo structure needs to be included. As an optimization in the Document page, when executing a document, only the first bone registered for a given grid includes the gridInfo structure.

    Returns
    • true if the grid bone properties should include the gridInfo.

    protected boolean showEmptyAxis ()

    protected boolean useDrillEvent ()

    protected boolean useRWDrillOutsideEvent ()

    protected boolean useViewModeGraphBone ()