Package com.microstrategy.web.app.transforms

Class ReportGraphTransformImpl

    • Field Detail

      • isGraphSrcAddSessionInfo

        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.

      • isGraphSrcFullPath

        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.

      • isDisableGraphDrilling

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

      • graphSize

        protected FormalParameter graphSize
        Graph Size to use.
        Allowed Values:
        PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE
        PreferencesGraphTransform.GRAPH_USE_USER_SIZE

      • showWidthHeightAttributes

        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.

      • graphWidth

        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

      • graphHeight

        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

      • shrinkGraphToWidth

        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

      • shrinkGraphToHeight

        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

      • imageSrc

        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.

      • graphImageFormat

        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

      • helpType

        public FormalParameter helpType
        Indicates the type of help topic this editor uses.
        Since:
        MicroStrategy Web 9.0.0

      • helpTopic

        public FormalParameter helpTopic
        Indicates the help topic for the help page of the editor.
        Since:
        MicroStrategy Web 9.0.0

      • FP_HELP_TYPE

        public static final java.lang.String FP_HELP_TYPE
        Constant specifying the type of the help file this editor should point to
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FP_HELP_TOPIC

        public static final java.lang.String FP_HELP_TOPIC
        Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
Since:
MicroStrategy Web 9.0.0

  • Constructor Detail

    • ReportGraphTransformImpl

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

  • Method Detail

    • renderImageMap

      public void renderImageMap​(MarkupOutput out)
      Renders a map on top of the graph image for drilling, context menus etc.
      Since:
      MicroStrategy Web 8.1.0

    • getOnClickJS

      protected java.lang.String getOnClickJS​(WebDrillPath wdp)

    • isContextMenusEnabled

      public boolean isContextMenusEnabled()
      Checks privileges to determine whether the graph should enable context menus on the graph.
      Overrides:
      isContextMenusEnabled in class AbstractAppTransform
      Returns:
      boolean - True if context menus are enabled.
      Since:
      MicroStrategy Web 9.0.0

    • renderEmptyCase

      public void renderEmptyCase​(MarkupOutput out,
                            ReportBean rb)
      Deprecated.
      Render when the report grid is empty.
      Usually some information message is displayed.
      Parameters:
      out - output by this transform
      rb - this report bean

    • renderLayout

      public void renderLayout​(MarkupOutput out,
                         ReportBean rb)
      Deprecated.
      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

    • renderData

      public void renderData​(MarkupOutput out,
                       ReportBean rb)
      Deprecated.
      Render the report data area.
      For graph reports, it's the graph itself.
      Parameters:
      out - output by this transform
      rb - this report bean

    • renderCenter

      public void renderCenter​(MarkupOutput out,
                         ReportBean rb)
      Deprecated.
      Render center area of the transform.
      Parameters:
      out - output by this transform
      rb - this report bean

    • renderGraphData

      public void renderGraphData​(MarkupOutput out,
                            ReportBean rb)
      Deprecated.
      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

    • renderGraph

      public void renderGraph​(MarkupOutput out,
                        ReportBean rb)
      Deprecated.
      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

    • renderGraph

      public void renderGraph​(MarkupOutput out)
      Renders the graph bone, it's shell and sets all the javascript properties.
      Since:
      MicroStrategy Web 8.0.0

    • renderGraphDropZones

      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.
      Since:
      MicroStrategy Web 9.0.0

    • renderDropZonesCssLink

      protected void renderDropZonesCssLink​(MarkupOutput out)
      Renders the various CSS classes on the Graph Drop Zones Editor.
      Since:
      MicroStrategy Web 9.0.0

    • renderScroller

      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
      Since:
      MicroStrategy Web 9.0.0

    • isGraphAreaDrillingSupported

      protected boolean isGraphAreaDrillingSupported()
      Returns whether Drilling is enabled on the Graph Areas.
      Since:
      MicroStrategy Web 9.0.0

    • renderGraphBone

      public void renderGraphBone​(MarkupOutput out)
      Renders the javascript bone associated with the graph.
      Since:
      MicroStrategy Web 8.1.0

    • renderGraphError

      public void renderGraphError​(MarkupOutput out)
      Renders an error message on the graph page based on the kind of error it is.
      Since:
      MicroStrategy Web 8.0.0

    • renderGraphTypesError

      protected void renderGraphTypesError​(MarkupOutput out)
      Renders an error message when an exception is thrown when no graph types are available.
      Parameters:
      out - MarkupOutput

    • renderPageByError

      protected void renderPageByError​(MarkupOutput out)
      Renders an error on the graph page when there's an invalid page by condition/argument.
      Since:
      MicroStrategy Web 8.0.0

    • renderNoDataError

      protected void renderNoDataError​(MarkupOutput out)
      Renders an error on the Graph page when there's no data returned on the graph.
      Since:
      MicroStrategy Web 8.0.0

    • renderInsufficientGraphDataError

      protected void renderInsufficientGraphDataError​(MarkupOutput out)
      Renders an error on the graph page when there's insufficient data available to render the graph.
      Parameters:
      out -

    • renderNoChartAvailable

      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

    • getGraphClientSideHelper

      protected ClientSideHelper getGraphClientSideHelper()
      Since:
      MicroStrategy Web 8.1.0

    • renderJavascript

      public void renderJavascript​(MarkupOutput out)
      Description copied from class: AbstractReportDataTransform
      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..
      Overrides:
      renderJavascript in class AbstractReportDataTransform
      Parameters:
      out - MarkupOutput to generate the HTML.
      Since:
      MicroStrategy Web 8.0.0

    • isDndEnabledForGraphs

      protected boolean isDndEnabledForGraphs()
      Returns, based on privileges, whether Drag and drop is available for the graph.
      Returns:
      True if the privileges are available.

    • getContextMenuManagerName

      protected java.lang.String getContextMenuManagerName()
      Returns the name of the Context Menu Manager assocaited with the graph.
      Overrides:
      getContextMenuManagerName in class AbstractAppTransform
      Since:
      MicroStrategy Web 9.0.0

    • isDesignMode

      public boolean isDesignMode()
      Description copied from class: AbstractReportTransform
      This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
      Overrides:
      isDesignMode in class AbstractReportTransform
      Returns:
      false by default. Any inherting class should override to implement its own version.
      Since:
      MicroStrategy Web 8.0.0

    • isGridGraphMode

      protected boolean isGridGraphMode()
      Since:
      MicroStrategy Web 8.0.0

    • useDrillEvent

      protected boolean useDrillEvent()
      Since:
      MicroStrategy Web 8.0.0

    • useRWDrillOutsideEvent

      protected boolean useRWDrillOutsideEvent()
      Since:
      MicroStrategy Web 9.0.0

    • getLoadGraphEvent

      protected WebEvent getLoadGraphEvent()
      Since:
      MicroStrategy Web 8.0.0

    • getDrillEvent

      protected WebEvent getDrillEvent()
      Since:
      MicroStrategy Web 8.0.0

    • getRWDrillOutsideEvent

      protected WebEvent getRWDrillOutsideEvent()
      Since:
      MicroStrategy Web 9.0.0

    • getGraphWidth

      protected java.lang.String getGraphWidth()
      Since:
      MicroStrategy Web 8.0.0

    • getGraphHeight

      protected java.lang.String getGraphHeight()
      Since:
      MicroStrategy Web 8.0.0

    • getGraphSrc

      protected java.lang.String getGraphSrc()
      Since:
      MicroStrategy Web 8.0.0

    • getGraphData

      public java.lang.String getGraphData()
      Get graph binary data and encode as base64. Note: refer to {#link ReportGraphImageTransform.java }
      Returns:
      String base64-encoded image binary

    • getGraphTooltip

      protected java.lang.String getGraphTooltip()
      Since:
      MicroStrategy Web 8.0.0

    • getAttributesBone

      public java.util.Map getAttributesBone()
      Since:
      MicroStrategy Web 8.0.0

    • getGraphBoneAttributes

      public java.util.Map getGraphBoneAttributes()
      Since:
      MicroStrategy Web 8.1.0

    • getAttributesGraph

      public java.util.Map getAttributesGraph​(boolean isLiveBone)
      Since:
      MicroStrategy Web 9.0.0

    • getImageId

      protected java.lang.String getImageId()
      Since:
      MicroStrategy Web 8.1.0

    • getGraphBean

      protected GraphBean getGraphBean()
      Since:
      MicroStrategy Web 8.0.0

    • isGraphAvailable

      public boolean isGraphAvailable()
      Since:
      MicroStrategy Web 8.0.0

    • isNoTypesAvailableError

      protected boolean isNoTypesAvailableError()
      Since:
      MicroStrategy Web 8.0.0

    • isInvalidPageByError

      protected boolean isInvalidPageByError()
      Since:
      MicroStrategy Web 8.0.0

    • isNoDataError

      protected boolean isNoDataError()
      Since:
      MicroStrategy Web 8.0.0

    • hasCenter

      public boolean hasCenter()
      Description copied from class: AbstractReportDataTransform
      Whether the transform has the center area. Out of box, it returns true.
      Specified by:
      hasCenter in class AbstractReportDataTransform
      Returns:
      Whether the transform has the center area
      Since:
      MicroStrategy Web 8.0.0

    • getDescription

      public java.lang.String getDescription()
      Return description for this Transform.
      Returns:
      The description as to what this Transform does.

    • getImageMapName

      protected java.lang.String getImageMapName()
      Since:
      MicroStrategy Web 8.1.0

    • getGraphBoneName

      protected java.lang.String getGraphBoneName()
      Since:
      MicroStrategy Web 8.1.0

    • showEmptyAxis

      protected boolean showEmptyAxis()
      Since:
      MicroStrategy Web 9.0.0

    • shouldRenderDropZones

      protected boolean shouldRenderDropZones()
      Since:
      MicroStrategy Web 9.0.0

    • shouldRenderGridInfo

      protected boolean shouldRenderGridInfo()
      Description copied from class: AbstractReportDataTransform
      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.
      Overrides:
      shouldRenderGridInfo in class AbstractReportDataTransform
      Returns:
      true if the grid bone properties should include the gridInfo.

    • useViewModeGraphBone

      protected boolean useViewModeGraphBone()
      Since:
      MicroStrategy Web 9.0.0