Package com.microstrategy.web.app.transforms

Class ReportAjaxVisualizationTransform

  • All Implemented Interfaces:
    AppTransform, ReportDataTransform, LayoutTransform, Transform
    Direct Known Subclasses:
    ReportAjaxMojoVisualizationTransform
    public class ReportAjaxVisualizationTransform
extends AbstractReportDataVisualizationTransform
    This transform serves as the base for a AJAX/DHTML visualization.
    It renders an iframe where the AJAX/DHTML visualization will reside. The iframe's SRC attribute will point to a URL that actually renders the visualization. This URL is created by using the formal parameters: _styleName or _iframeSrc

    Note: The use of an iframe is recommended, though not enforced, to avoid conflicts with the visualization's CSS styles or javascript code and the ones used by MicroStrategy Web
    Since:
    MicroStrategy Web 8.1.1

    • Field Detail

      • _styleName

        public FormalParameter _styleName
        The name of the style to use to render the AJAX/DHTML visualization.
        Ignored is _iframeSrc is set. Allowed Values: String value that corresponds to a style on the styleCatalog.

      • _iframeExtraAttrs

        public FormalParameter _iframeExtraAttrs
        Extra attributes for the iframe tag.
        Allowed Values: Any string with attributes to be added to the iframe tag. For example frameborder="0"
        Since:
        MicroStrategy Web 8.1.2

      • _iframeSrc

        public FormalParameter _iframeSrc
        The source for the iframe. Used if the source is static. Allowed Values: Any URL. For example: ../VisFramework/map/map.html
        Since:
        MicroStrategy Web 8.1.2

      • _viewModes

        public FormalParameter _viewModes
        The view modes that the visualization allows to be rendered. Allowed values: The OR values from EnumDSSXMLViewMedia
        Since:
        MicroStrategy Web 9.3.1

      • _zoomFactor

        public FormalParameter _zoomFactor
        The zoom factor that the visualization to be rendered. Allowed values: Integer. For example: 1 stands for the origin size
        Since:
        MicroStrategy Web Polaris

      • _forceShowForm

        public FormalParameter _forceShowForm
        The flag to force displaying all the attribute forms. Allowed values: Boolean. True means show all the forms, false means show headers by default.
        Since:
        MicroStrategy Web Polaris

    • Constructor Detail

      • ReportAjaxVisualizationTransform

        public ReportAjaxVisualizationTransform()

    • Method Detail

      • getIframeSource

        protected java.lang.String getIframeSource()
        Since:
        MicroStrategy Web 8.1.2

      • getIFrameSrcExtraParameters

        protected HashList<java.lang.String,​java.lang.String> getIFrameSrcExtraParameters()

      • getGridDataUrl

        protected ParameterBuilder getGridDataUrl()
        Returns:
        A URL that can be used to get the report data using the style specified on the "reportXMLStyle" formal parameter

      • getGridBoneJson

        protected java.lang.String getGridBoneJson()
        Deprecated.
        use getGridDataUrl()

      • renderGridDataUrl

        public void renderGridDataUrl​(MarkupOutput out)
        Render a URL that can be used to get the report data using the style specified on the "reportXMLStyle" formal parameter

      • getContainerWidth

        protected java.lang.String getContainerWidth()
        Returns the width of the container.
        It first checks for the "containerWidth" formal parameter, which is set on the case of grids in documents. If this is empty it checks for the "width" formal parameter
        Returns:
        the width of the container.

      • getContainerHeight

        protected java.lang.String getContainerHeight()
        Returns the height of the container.
        It first checks for the "containerheight" formal parameter, which is set on the case of grids in documents. If this is empty it checks for the "height" formal parameter
        Returns:
        the height of the container.

      • renderContainerWidth

        public void renderContainerWidth​(MarkupOutput out)
        Renders the width of the container
        Calls getContainerWidth()
        Parameters:
        out - The Markup output

      • renderContainerHeight

        public void renderContainerHeight​(MarkupOutput out)
        Renders the height of the container
        Calls #getContainerheight()
        Parameters:
        out - The Markup output