PptChartSettings

From Q
Jump to navigation Jump to search

PptChartSettings

Represents various customization options for a particular chart for powerpoint export Tries to be the intersect between chart features powerpoint supports AND the features our charting libraries use This class should be designed to be easy to serialize/deserialize and should be documented heavily so plot authors can supply these settings to us for export

BackgroundColor

The background color of the plot area (defaults to transaparent) Accepts STRING values in the formats: #RRGGBB, #RRGGBBAA

BubbleScale

Bubble scale as a percentage Accepts INTEGER values 0 to 300

BubbleSizeType

Bubble size value represents either Area of bubble or Width of bubble (for Bubble charts) Accepts STRING values: Area, Width

ChartTitleFont

The font and color of the chart title (only used if shown) Accepts a named LIST of ExportingFontAndColor values

ChartTitlePosition

The alignment of the chart title (only used if shown) Accepts STRING values: Near, Center, Far or NULL

FirstSliceAngle

The angle of rotation for the first series in a Pie-like chart Accepts INTEGER values 0 to 360

GapDepth

The depth gap between 3d bars as a percentage of the bar depth (for 3D Area/Bar-like Charts) Accepts INTEGER values 0 to 500

GapWidth

The gap between bars as a percentage of the bar width (for Bar-like Charts) Accepts INTEGER values 0 to 500

HoleSize

Hole size as a percentage of the pie (for Pie-like chart) Accepts INTEGER values 10 to 90

Legend

The legend settings (only used if shown) Accepts a named LIST of PptLegendSettings values

Overlap

How much each series overlaps with its neighbour (for Bar-like Charts) * a setting of 100 signifies complete overlap ie. stacked * a setting of 0 signifies no overlap ie. clustered Accepts INTEGER values -100 to 100

Perspective

Viewpoint perspective for 3D charts Accepts INTEGER values 0 to 255 or NULL

PieExplosion

The separation between pie slices on Pie explosion charts Accepts INTEGER values 0 to 4,294,967,295

PlotScale

Scale factor for plot area (between 0 and 1) If null, powerpoint defaults to a maximum of 0.96 to leave nice looking margins around the plot WARNING: setting this to not-null can cause the plot area to overlap legends and titles Accepts REAL values 0 to 1 or NULL

PrimaryAxis

The primary chart axis. This is usually the horizontal axis at the bottom (bar charts have them on the left). Depending on the type of chart: this can be a category, date or value axis. Accepts a named LIST of PptAxisSettings values or NULL

RotateX

Viewpoint X rotation for 3D charts Accepts INTEGER values -128 to 127

RotateY

Viewpoint Y rotation for 3D charts Accepts INTEGER values 0 to 65,536

SecondPieSize

The size of the second pie as a percentage of the pie (for an OfPie chart) Accepts INTEGER values 5 to 200

SeriesAxis

The 3rd axis used for 3D charts Accepts a named LIST of PptAxisSettings values or NULL

ShowChartTitle

Whether or not to show a chart title Accepts LOGICAL values: TRUE, FALSE

ShowLegend

Whether or not to show the legend Accepts LOGICAL values: TRUE, FALSE

ShowNegativeBubbles

Shows bubbles that have negative values Accepts LOGICAL values: TRUE, FALSE

Smooth

Whether to smooth the line series Accepts LOGICAL values: TRUE, FALSE

TemplateSeries

A list of series settings. If less settings are provided than the actual number of series, the last series settings is duplicated for the remaining series. Accepts a non-empty LIST of named LISTS of PptSeriesSettings values

ValueAxis

Typically the y axis (except for bar charts) Accepts a named LIST of PptAxisSettings values or NULL