Chart options for an embedded pivot worksheet

Embedded worksheets contain a chart component that allows the user to view the generated data in a graphical format. The chart can be included with the pivot table and displayed below the same. The chart can also be used instead of the table or can be hidden. These are the worksheet parameters used to control the chart configuration and behavior:

Field	Name	Default	Description
rv_chart_export_size	Chart Export Size	600:400	The size of the chart image, in pixels, when exporting the worksheet to PDF or Excel. The embedded chart is a static image and cannot be edited, after an export. A minimum of two numbers must be specified, in the format. If not specified and the worksheet with chart data is exported, the default value of 600:400 is considered.
rv_chart_number	Chart Type	0	The type of chart displayed below the pivot area: 0 or not defined = No Chart 1 = Column chart (vertical bars) 2 = Line chart 3 = Pie chart 4 = Area chart 5 = Bar chart (horizontal bars) 6 = Map chart 8 = Funnel chart You can override these values for a specific measure, using the chartnumber property in the rv_measure_format parameter.
rv_chart_rows	Chart Rows	TRUE	Indicates if the chart is based on rows or columns; TRUE= chart is based on data required from the elements used to create the left dimensions (rows), FALSE = chart is based on data required from the elements used to create the top dimensions (columns) . When not defined, Default = TRUE. When charting rows, each combination on the left dimension is a series in the chart, either a separate bar, line, area, or a separate slice, or a stacked section. Each combination of elements on the top dimension creates categories on the X-Axis. When the chart row = FALSE, this is reverted and each combination on the top dimension is a series in the chart, with the elements on the left representing the X-Axis categories.
rv_fit_panel	Fit to Panel	TRUE	Used to determine if the chart must fit the available panel width (=TRUE), or use the default sizing, with the optional scrollbars; to view the axes categories (=FALSE). Not applicable where chart type = 3, 7 or 8 (Pie, Chart, or Gauge). Fit to panel is always true (rv_fit_panel is ignored), when displaying a chart in 3D.
rv_legend_position	Legend Position	1	Indicates the position of the chart legend (key) in relation to the chart area. 0 = None 1 = Left 2 = Right 3 = Top 4 = Bottom 5 = Data Label ( Only applicable when rv_chart_number = 3 (Pie chart) and 8 (Funnel). The data is displayed on a chart and not a legend. When not defined, Default = 1 (Left).
rv_map_type	Map Type	1	Selected from the World map list (Continents, Africa, Asia, Oceania, Europe, North America, South America, and USA). Indicates the type of Map that must be displayed below the pivot area. Default = 0 (World map) or if not defined = Best Fit. The map type is an enumeration of the list and copies the corresponding map number to `rv_map_type`.
rv_min_chart_size	Minimum Chart Size	0	Indicates the minimum size of the chart area in a panel, when the chart must be drawn. This parameter can be used in multi-panel worksheets to ensure that the chart is not drawn, when the panel size is not sufficient. For example, for the size of 100, the chart is drawn, only if the remaining area after the pivot is 100 pixels or more. If less, the chart is not drawn. Applicable only wherein rv_pivot_hide = FALSE, that is the pivot table is displayed. When not defined, the default value 0 is used.
rv_pivot_hide	Hide Pivot	FALSE	Used to determine if the pivot table area must be hidden (=TRUE) and only the chart area is displayed or if the pivot area must also be displayed (=FALSE). Only applicable if rv_chart_number > 0, otherwise the pivot area is always displayed. When not defined, Default = FALSE.
rv_map_show_labels	Show Map Data labels	TRUE	Used to determine if the location labels are displayed on the map. For example, to display all the country names on the world map. Default = TRUE (when not defined).
rv_map_show_title	Show Map title	FALSE	Used to determine if the analyzed measure is displayed in the map. When FALSE or undefined, the measure is displayed as the legend title.
rv_pivot_size	Pivot size	None	Indicates the size of the pivot table area (in pixels) in the current panel and the remaining area in which the chart is displayed. Applicable if a chart is displayed (rv_chart_number > 0), otherwise the pivot table is not drawn in the panel area. If rv_pivot_size is not defined then the space is allotted equally between the pivot and chart.
rv_stacked_type	Stacked type	None	Indicates if the series on the chart are separate (None), stacked, or a stacked percentage up to 100%. 0 = None 1 = Stacked 2 = Percentage The parameter can be used with the chart type to generate stacked or 100% stacked versions of all the chart types, However, this parameter is ignored if the chart type is a Pie chart. Default = 0 (None); when not defined, a separate series is displayed.
rv_x_label_Type	X-Axis Label Type	1	Used to determine the type of X-Axis labels to be displayed for the chart. 0 = None 1 = Normal 2 = Grouped When not defined, Default = 1.
rv_map_continent_attr	Continent Attribute	None	Specified by the user to indicate the location attribute that determines the continent. This field is required when displaying the world continent map.
rv_map_country_attr	Country Attribute	None	Specified by the user to indicate the location attribute that determines the country. This is an optional attribute, but is required to display the world map or individual continent maps.
rv_map_province_attr	Province Attribute	None	Specified by the user to indicate the location attribute to determine the province (that is state, region and so on). This is an optional attribute, required to display an individual country map.
rv_map_latitude	Latitude coordinate		Specified by the user to indicate the latitude coordinate that determines the location of the data on the map. This parameter is required when using `rv_chart_type = 9` (Map - Coordinates).
rv_map_longitude	Longitude coordinate		Specified by the user to indicate the longitude coordinate that determines the location of the data on the map. This parameter is required when using `rv_chart_type = 9` (Map - Coordinates).
rv_map_crosshairs	Show crosshairs	FALSE	Used to determine if cross hairs must be displayed on maps. When FALSE or undefined, cross hairs are not displayed. Default = FALSE. When set to TRUE, cross hairs are displayed on the map. Only valid when rv_chart_type = 6 or 9.
rv_color_palette	Color Palette	0	The available color options: Azure, Amber, Amethyst, Turquoise, Ruby, Emerald, Graphite, Slate. The parameter value must be in the range of 0 - 7 to represent the corresponding color that must be used. Default = Azure (0) when not defined. Only applicable when rv_chart_number = 6 or 9. The color palette is an ordered listing that ranges from Azure = 0 to Slate = 7; the corresponding number is added to the rv_color_palette parameter. Note: If rv_measure_format is defined, then the rv_color_palette parameter is not considered.
rv_y_label_hide	Hide Y-Axis Labels	FALSE	Used to determine if the Y-Axis labels must be displayed or not on the chart (=TRUE), displayed (=FALSE). When not defined, Default = FALSE.
rv_single_tooltip	Display single Tooltip	FALSE	Used to determine if the tooltips for the charts must be displayed as a single point tooltip or a shared tooltip, for all elements on the axis. When not defined, Default = TRUE.
rv_map_hide_nullareas	Hide Zero Locations	FALSE	Used to indicate if a location (country, province, and so on must be hidden on the map (TRUE), or always displayed irrespective of the value. Default = FALSE (when not defined).
rv_pie_style	Pie chart style	0	Indicates the pie chart style such as standard pie, donut pie chart or semicircle donut pie chart. 0 = standard pie chart 1 = donut pie chart 2 = semicircle donut pie chart Default = 0 when not defined Only applicable when rv_chart_number = 3
rv_chart_3d	Display chart in 3D	FALSE	Indicates if the applicable charts must be displayed in 3D. Default = FALSE when not defined. Only applicable for rv_chart_number 1, 3, 5. If rv_chart_number = 3 (pie chart), the 3D style is only applicable when the rv_pie_style = 0 or 1. If rv_pie_style = 2, rv_chart_3d is not considered. When displaying the chart, a 3D fit to panel is considered (rv_fit_panel is ignored).
rv_gauge_style	Gauge Chart Style	0	Indicates the gauge chart style (Solid Gauge or Angular Gauge). If not defined, 0 = Solid, Gauge 1 = Angular Gauge, and Default = 0 (Solid). Only applicable when rv_chart_number = 7 (gauge).

Table 1. Parameters for filtering elements
Field	Name	Default	Description
rv_measure_graphhide	Measures Hidden on Graph	None	The list of measures that must not be displayed on the graph when the worksheet is uploaded. This is a subset of rv_measure_passed parameter. A single element [element1] or a set in the form {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the measures for the rv_measure_passed are displayed. To view the measure that is displayed on the legend but not on the graph, you must select the measure on the legend. Note: This value is applicable only if the rv_measure_except is excluded.
rv_history_graphhide	History Elements Hidden on Graph	None	The list of history elements that must not be displayed on the graph, when the worksheet is uploaded. This is a subset of the rv_history_passed parameter. A single element [element1] or a set in the form {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_history_passed parameter, are displayed. To view the history element that is displayed on the legend but not on the graph, you must select the history element on the legend.
rv_item_graphhide	Items Hidden on Graph	None	The list of items that must not be displayed on the graph, when the worksheet is uploaded. This is a subset of the rv_item_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the items specified for the rv_item_passed parameter, are displayed. To view the item that is displayed on the legend but not on the graph, you must select the item on the legend. Note: This value is applicable only if the rv_measure_except is excluded.
rv_location_graphhide	Locations Hidden on Graph	None	The list of locations that must not be displayed on the graph, when the worksheet is uploaded. This is a subset of the rv_locations_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all locations specified for the the rv_locations_passed parameter, are displayed. To view the location that is displayed on the legend but not on the graph, you must select the location on the legend. Note: This value is applicable only if the rv_measure_except is excluded.
rv_period_graphhide	Periods Hidden on Graph	None	The list of periods that must not be displayed on the graph, when the worksheet is uploaded. This is a subset of the rv_period_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the periods specified for the rv_period_passed parameter, are displayed. To view the period that is displayed on the legend but not on the graph, you must select the period on the legend. Note: This value is applicable only if the rv_measure_except is excluded.
rv_scenario_graphhide	Scenarios Hidden on Graph	None	The list of scenarios that must not be displayed on the graph, when the worksheet is uploaded. This is a subset of the rv_scenario_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports MDX definition for the set. If not defined, all the scenarios specified for the rv_scenario_passed parameter, are displayed. To view the scenario that is displayed on the legend but not on the graph, you must select the scenario on the legend. Note: This value is applicable only if the rv_measure_except is excluded.

Conditions:

By default, the chart is based on the data specified for the rows (left dimensions), which is used to plot (link) the left dimension elements.
- If more than 1 dimension exists on the left, these dimensions are concatenated (linked in a series) such that, each unique combination is plotted.
Each unique combination of the top dimension element is a category (label) on the X-Axis.
If rv_chart_rows = FALSE, the chart is 'reversed' and the data on the top dimensions is plotted, using the left dimensions to create the X-Axis categories.
Measures with the default format or the rv_measure_format of 0% or 0.00% are plotted on a separate axis:
- This axis can be scaled to the required percentage values.
- Values must be plotted as the corresponding % value (that is 75%, not 0.75).
- In case, some measures are defined with a format of secondaxis = TRUE, the chart also displays a 3rd axis - primary, % format, and the alternate axis.
- Whether the % format or alternate axis for measures where secondaxis=TRUE is displayed first, depends on which is encountered first ,when iterating through the measures for the worksheets.
Area charts are used to draw a series in the average value descending order, so that the largest series is drawn in the background, with smaller series in the foreground. All the other chart types are drawn in the order of the elements in the pivot (specified dimension sort order).