Supported Bean: GraphFormatEditorBean

This class provides the graph formatting editor interface for modifying the looks of the graph currently being displayed to the user.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanGraphFormatEditor (34)

Application bean type for the Graph Format Editor bean

Events

apply, cancel, changeMajorType, closeEditor, ok, openEditor, processAxesTab, processFormatTab, processGeneralTab, processTitlesTab, setTopLeft, switchTab, switchTarget

apply
Event to execute the main action of the ReportEditor

17003

EnumFrameEditorEvents.WebEventApply

cancel
Equivalent to close.

17005

EnumFrameEditorEvents.WebEventCancel

changeMajorType
Identifier for the event that allows users to change the major type of the selected graph report.

34006

EnumGraphFormatEditorEvents.WebEventProcessChangeMajorType

*major

Identifier for the argument that indicates which graph major type style should be applied. Usage:
The graph major types that can be applied to the current report depend on the type of information it contains. The list of possible values that can be shown is included and read from the WEB-INF/xml/GraphTypes.xml configuration file. The value to assign to this argument can be any of the values specified for the major attribute.

34018

EnumGraphFormatEditorEvents.WebEventArgumentGraphMajorType

closeEditor
Event to close the ReportEditor

17002

EnumFrameEditorEvents.WebEventClose

ok
Event corresponding to apply and close.

17004

EnumFrameEditorEvents.WebEventOk

openEditor
Event to open the ReportEditor

17001

EnumFrameEditorEvents.WebEventOpen

processAxesTab
Identifier for the event that allows users to submit the indicated changes on the Axes properties tab of the editor.

34005

EnumGraphFormatEditorEvents.WebEventProcessAxesTabProperties

apply

Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

34024

EnumGraphFormatEditorEvents.WebEventArgumentApplyGraphFormatChanges

catAx

Identifier for the argument that indicates the prefix to use for identifying properties of the Category Axis values. Usage:
The Category Axis value properties can be specified as a combination of maximum value limit, minimum value limit and/or display intervals. This information is identified by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatAxisParameters, such as EnumGraphFormatAxisParameters.GraphFormatAxisShowParameter, EnumGraphFormatAxisParameters.GraphFormatAxisMaxParameter, etc.

34009

EnumGraphFormatEditorEvents.WebEventArgumentCategoryAxisValues

close

Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

34023

EnumGraphFormatEditorEvents.WebEventArgumentCloseGraphEditor

ok

Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

34022

EnumGraphFormatEditorEvents.WebEventArgumentApplyAndCloseGraphEditor

seriesAx

Identifier for the argument that indicates the prefix to use for identifying properties of the Series Axis values. Usage:
The Series Axis value properties can be specified as a combination of maximum value limit, minimum value limit and/or display intervals. This information is identified by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatAxisParameters, such as EnumGraphFormatAxisParameters.GraphFormatAxisShowParameter, EnumGraphFormatAxisParameters.GraphFormatAxisMaxParameter, etc.

34007

EnumGraphFormatEditorEvents.WebEventArgumentSeriesAxisValues

xAx

Identifier for the argument that indicates the prefix to use for identifying properties of the X Axis values. Usage:
The X Axis value properties can be specified as a combination of maximum value limit, minimum value limit and/or display intervals. This information is identified by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatAxisParameters, such as EnumGraphFormatAxisParameters.GraphFormatAxisShowParameter, EnumGraphFormatAxisParameters.GraphFormatAxisMaxParameter, etc.

34010

EnumGraphFormatEditorEvents.WebEventArgumentXAxisValues

y1Ax

Identifier for the argument that indicates the prefix to use for identifying properties of the Y1 Axis values. Usage:
The Y1 Axis value properties can be specified as a combination of maximum value limit, minimum value limit and/or display intervals. This information is identified by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatAxisParameters, such as EnumGraphFormatAxisParameters.GraphFormatAxisShowParameter, EnumGraphFormatAxisParameters.GraphFormatAxisMaxParameter, etc.

34011

EnumGraphFormatEditorEvents.WebEventArgumentY1AxisValues

y2Ax

Identifier for the argument that indicates the prefix to use for identifying properties of the Y2 Axis values. Usage:
The Y2 Axis value properties can be specified as a combination of maximum value limit, minimum value limit and/or display intervals. This information is identified by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatAxisParameters, such as EnumGraphFormatAxisParameters.GraphFormatAxisShowParameter, EnumGraphFormatAxisParameters.GraphFormatAxisMaxParameter, etc.

34012

EnumGraphFormatEditorEvents.WebEventArgumentY2AxisValues

yAx

Identifier for the argument that indicates the prefix to use for identifying properties of the Y Axis values. Usage:
The Y Axis value properties can be specified as a combination of maximum value limit, minimum value limit and/or display intervals. This information is identified by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatAxisParameters, such as EnumGraphFormatAxisParameters.GraphFormatAxisShowParameter, EnumGraphFormatAxisParameters.GraphFormatAxisMaxParameter, etc.

34008

EnumGraphFormatEditorEvents.WebEventArgumentYAxisValues

processFormatTab
Identifier for the event that allows users to submit the indicated changes on the Format properties tab of the editor.

34008

EnumGraphFormatEditorEvents.WebEventProcessFormatTabProperties

content

Argument for the content of an object in the graph

34044

EnumGraphFormatEditorEvents.WebEventArgumentContent

fillColor

Argument for the fill color of an object in the graph

34046

EnumGraphFormatEditorEvents.WebEventArgumentFillColor

fontColor

Argument for the font color of an object in the graph

34039

EnumGraphFormatEditorEvents.WebEventArgumentFontColor

fontName

Argument for the font name of an object in the graph

34042

EnumGraphFormatEditorEvents.WebEventArgumentFontName

fontSize

Argument for the font size of an object in the graph

34040

EnumGraphFormatEditorEvents.WebEventArgumentFontSize

fontStyle

Argument for the font style of an object in the graph

34041

EnumGraphFormatEditorEvents.WebEventArgumentFontStyle

lineColor

Argument for the line color of an object in the graph

34045

EnumGraphFormatEditorEvents.WebEventArgumentLineColor

position

Argument for the position of an object in the graph

34043

EnumGraphFormatEditorEvents.WebEventArgumentPosition

show

Argument for the show/hide a particular object in the graph

34038

EnumGraphFormatEditorEvents.WebEventArgumentShow

processGeneralTab
Identifier for the event that allows users to submit the indicated changes on the General properties tab of the editor.

34003

EnumGraphFormatEditorEvents.WebEventProcessGeneralTabProperties

apply

Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

34024

EnumGraphFormatEditorEvents.WebEventArgumentApplyGraphFormatChanges

cat

Identifier for the argument that indicates the number of categories to show in the graph. Usage:
Here, the number of categories - or rows of information - to show in the graph can be specified. This will determine the behavior of Incremental Fetch. If the number selected is larger than the actual number of rows to graph, the effect will be to show all the rows of information on the same image.

34020

EnumGraphFormatEditorEvents.WebEventArgumentGraphCategories

close

Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

34023

EnumGraphFormatEditorEvents.WebEventArgumentCloseGraphEditor

fontLock

34034

EnumGraphFormatEditorEvents.WebEventArgumentFontLock

major

Identifier for the argument that indicates which graph major type style should be applied. Usage:
The graph major types that can be applied to the current report depend on the type of information it contains. The list of possible values that can be shown is included and read from the WEB-INF/xml/GraphTypes.xml configuration file. The value to assign to this argument can be any of the values specified for the major attribute.

34018

EnumGraphFormatEditorEvents.WebEventArgumentGraphMajorType

minor

Identifier for the argument that indicates which graph minor type style should be applied. Usage:
The graph minor types that can be applied to the current report depend on the type of information it contains and the current major type selected. The list of possible values that can be shown is included and read from the WEB-INF/xml/GraphTypes.xml configuration file. The value to assign to this argument can be any of the values specified for the minor attribute.

34019

EnumGraphFormatEditorEvents.WebEventArgumentGraphMinorType

ok

Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

34022

EnumGraphFormatEditorEvents.WebEventArgumentApplyAndCloseGraphEditor

series

Identifier for the argument that indicates the number of series to show in the graph. Usage:
Here, the number of series - or columns of information - to show in the graph can be specified. This will determine the behavior of Incremental Fetch. If the number selected is larger than the actual number of columns to graph, the effect will be to show all the columns of information on the same image.

34021

EnumGraphFormatEditorEvents.WebEventArgumentGraphSeries

serLayout

34033

EnumGraphFormatEditorEvents.WebEventArgumentSeriesLayout

subtotals

34035

EnumGraphFormatEditorEvents.WebEventArgumentSubtotals

processTitlesTab
Identifier for the event that allows users to submit the indicated changes on the Titles properties tab of the editor.

34004

EnumGraphFormatEditorEvents.WebEventProcessTitlesTabProperties

_subtitle

Identifier for the argument that indicates the prefix to use for identifying properties of the graph's subtitle. Usage:
The graph's subtitle can be formatted in several different fields, including content, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34015

EnumGraphFormatEditorEvents.WebEventArgumentSubtitle

apply

Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

34024

EnumGraphFormatEditorEvents.WebEventArgumentApplyGraphFormatChanges

catAx

Identifier for the argument that indicates the prefix to use for identifying properties of the Category Axis title. This argument is used for prefixing the different properties related with the Category Axis title that the user can specify for having them customized on the graph.
Usage:
The Category Axis title can be formatted in several different fields, including the text it shows, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34004

EnumGraphFormatEditorEvents.WebEventArgumentCategoryAxisTitle

close

Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

34023

EnumGraphFormatEditorEvents.WebEventArgumentCloseGraphEditor

colh

34025

EnumGraphFormatEditorEvents.WebEventArgument3DColHeader

footnote

Identifier for the argument that indicates the prefix to use for identifying properties of the graph's footnote. Usage:
The graph's footnote can be formatted in several different fields, including content, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34016

EnumGraphFormatEditorEvents.WebEventArgumentFootnote

legend

Identifier for the argument that indicates the prefix to use for identifying properties of the graph's legend. Usage:
The graph's legend can be formatted in several different fields, including font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc. The text it shows is generated automatically, so there's no way for customizing this property, therefore EnumGraphFormatTextParameters.GraphFormatTextContentParameter does not apply.

34013

EnumGraphFormatEditorEvents.WebEventArgumentLegend

lrh

34027

EnumGraphFormatEditorEvents.WebEventArgument3DLRHeader

lyh

34026

EnumGraphFormatEditorEvents.WebEventArgument3DLYHeader

o1label

34029

EnumGraphFormatEditorEvents.WebEventArgument2DO1Label

ok

Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

34022

EnumGraphFormatEditorEvents.WebEventArgumentApplyAndCloseGraphEditor

rowh

34028

EnumGraphFormatEditorEvents.WebEventArgument3DRowHeader

seriesAx

Identifier for the argument that indicates the prefix to use for identifying properties of the Series Axis title. This argument is used for prefixing the different properties related with the Series Axis title that the user can specify for having them customized on the graph.
Usage:
The Series Axis title can be formatted in several different fields, including the text it shows, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34002

EnumGraphFormatEditorEvents.WebEventArgumentSeriesAxisTitle

title

Identifier for the argument that indicates the prefix to use for identifying properties of the graph's title. Usage:
The graph's title can be formatted in several different fields, including content, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34014

EnumGraphFormatEditorEvents.WebEventArgumentTitle

values

Identifier for the argument that indicates the prefix to use for identifying properties of the graph's data values. Usage:
The graph's data values can be formatted in several different fields, including font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc. The text it shows is generated automatically, so there's no way for customizing this property, therefore EnumGraphFormatTextParameters.GraphFormatTextContentParameter does not apply.

34017

EnumGraphFormatEditorEvents.WebEventArgumentDataValues

x1label

34030

EnumGraphFormatEditorEvents.WebEventArgument2DX1Label

y1Ax

Identifier for the argument that indicates the prefix to use for identifying properties of the Y1 Axis title. This argument is used for prefixing the different properties related with the Y1 Axis title that the user can specify for having them customized on the graph.
Usage:
The Y1 Axis title can be formatted in several different fields, including the text it shows, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34005

EnumGraphFormatEditorEvents.WebEventArgumentY1AxisTitle

y1label

34031

EnumGraphFormatEditorEvents.WebEventArgument2DY1Label

y2Ax

Identifier for the argument that indicates the prefix to use for identifying properties of the Y2 Axis title. This argument is used for prefixing the different properties related with the Y2 Axis title that the user can specify for having them customized on the graph.
Usage:
The Y2 Axis title can be formatted in several different fields, including the text it shows, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34006

EnumGraphFormatEditorEvents.WebEventArgumentY2AxisTitle

y2label

34032

EnumGraphFormatEditorEvents.WebEventArgument2DY2Label

yAx

Identifier for the argument that indicates the prefix to use for identifying properties of the Y Axis title. This argument is used for prefixing the different properties related with the Y Axis title that the user can specify for having them customized on the graph.
Usage:
The Y Axis title can be formatted in several different fields, including the text it shows, font name, font size, color and font style used. This information is indicated by the prefix indicated by this argument, combined with an identifier for each one of the fields, defined on EnumGraphFormatTextParameters, such as EnumGraphFormatTextParameters.GraphFormatTextShowParameter, EnumGraphFormatTextParameters.GraphFormatTextFontColorParameter, EnumGraphFormatTextParameters.GraphFormatTextFontNameParameter, etc.

34003

EnumGraphFormatEditorEvents.WebEventArgumentYAxisTitle

setTopLeft
Event for setting the top left position of the component

73001

EnumAppComponentEvents.WebEventSetTopLeftPosition

*left

Event argument to define the left (x) position of the component

73002

EnumAppComponentEvents.WebEventArgumentLeftPosition

*top

Event argument to define the top (y) position of the component

73001

EnumAppComponentEvents.WebEventArgumentTopPosition

switchTab
Identifier for the event that allows users to switch the tab currently displayed with the graph formatting information.

34001

EnumGraphFormatEditorEvents.WebEventSwitchEditorTab

*tab

Identifier for the argument that indicates the tab the user requested to be shown. Usage:
Possible values for this argument include those listed on the EnumGraphFormatEditorTabs enumeration, such as EnumGraphFormatEditorTabs.GraphFormatGeneralTab, EnumGraphFormatEditorTabs.GraphFormatTitlesTab, etc.

34001

EnumGraphFormatEditorEvents.WebEventArgumentTab

switchTarget
Identifier for the event that allows users to change the target in the graph formatting editor

34007

EnumGraphFormatEditorEvents.WebEventSwitchTarget

*target

Argument for the target of the graph format editor

34037

EnumGraphFormatEditorEvents.WebEventArgumentTarget


Notes

* denotes required field.