| Package | com.flexmonster.pivot.vo |
| Class | public class OptionsValueObject |
| Inheritance | OptionsValueObject  Object |
| Property | Defined By | ||
|---|---|---|---|
| chartAutoRange : Boolean
Indicates whether the range of values on the charts is selected automatically or not. | OptionsValueObject | ||
| chartMultipleMeasures : Boolean
Indicates whether to show multiple measures on charts. | OptionsValueObject | ||
| chartType : String
Selected chart type. | OptionsValueObject | ||
| classicView : Boolean
Defines whether pivot table should be shown in the classic view (true) or not (false). | OptionsValueObject | ||
| configuratorActive : Boolean
Indicates whether the Fields List is opened (true) or closed (false). | OptionsValueObject | ||
| configuratorButton : Boolean
Indicates whether the Fields List toggle button is visible (true) or not (false). | OptionsValueObject | ||
| configuratorMatchHeight : Boolean
Indicates whether the Fields List will be the same height as the component (true) or it's height will be defined by its content amount (false). | OptionsValueObject | ||
| datePattern : String
Default value is "dd/MM/yyyy". | OptionsValueObject | ||
| drillThrough : Boolean
Indicates whether the drill through feature is enabled (true) or disabled (false). | OptionsValueObject | ||
| editing : Boolean
Indicates whether the editing feature is enabled (true) or disabled (false) on the Drill Through popup for CSV data sources. | OptionsValueObject | ||
| fitGridlines : Boolean
Indicates whether the gridlines are shown for all cells (false) or only non-empty (true). | OptionsValueObject | ||
| flatView : Boolean
Defines whether data should be shown in the flat view (true) or not (false). | OptionsValueObject | ||
| htmlFooter : String Deprecated Since 2.1: Please Use ExportOptions.footer
Footer in HTML format which is added to exported HTML. | OptionsValueObject | ||
| htmlHeader : String Deprecated Since 2.1: Please Use ExportOptions.header
Header in HTML format which is added to exported HTML. | OptionsValueObject | ||
| ignoreQuotedLineBreaks : Boolean
Indicates whether the line breaks in quotes will be ignored (true) in CSV files or not (false). | OptionsValueObject | ||
| pdfFontUrl : String Deprecated Since 2.1: Please Use ExportOptions.fontUrl
Specifies the path to the external font (TTF) which will be used during exporting to PDF. | OptionsValueObject | ||
| pdfFooter : String Deprecated Since 2.1: Please Use ExportOptions.footer
Footer in HTML format (only limited amount of tags are supported: div, p, span, br, img with base64 src, some basic inline styles) which is added to each page of exported PDF. | OptionsValueObject | ||
| pdfHeader : String Deprecated Since 2.1: Please Use ExportOptions.header
Header in HTML format (only limited amount of tags are supported: div, p, span, br, img with base64 src, some basic inline styles) which is added to each page of exported PDF. | OptionsValueObject | ||
| showAggregations : Boolean
Indicates whether the aggregation selection control is visible (true) or not (false) for measures on Fields List. | OptionsValueObject | ||
| showCalculatedValuesButton : Boolean
Defines the visibility of "Add calculated value" link in Fields List. | OptionsValueObject | ||
| showChartLegendButton : Boolean
Indicates whether the button to show/hide the legend on charts is visible. | OptionsValueObject | ||
| showChartMeasures : Boolean
Indicates whether all dropdowns on the top of charts are visible (true) or not (false). | OptionsValueObject | ||
| showChartsWarning : Boolean
Indicates whether the warning are shown if data is too big for charts. | OptionsValueObject | ||
| showDefaultSlice : Boolean
Defines whether the component selects a default slice for the report with empty slice (when nothing is set in rows, columns, pages and measures). | OptionsValueObject | ||
| showFilter : Boolean
Indicates whether the opening columns/rows filter controls and page filter controls are visible (true) or not (false) on the grid. | OptionsValueObject | ||
| showFilterInCharts : Boolean
Indicates whether the opening columns and rows filter controls are visible (true) or not (false) on the charts. | OptionsValueObject | ||
| showFiltersExcel : Boolean Deprecated Since 2.1: Please Use ExportOptions.showFilters
Indicates whether the filters info will be shown (true) in exported Excel file or not (false). | OptionsValueObject | ||
| showGrandTotals : String
Specifies how to show grand totals: in rows ("rows"), in columns ("columns"), in rows and columns ("on") or hide them ("off"). | OptionsValueObject | ||
| showHeaders : Boolean
Indicates whether the spreadsheet headers are visible (true) or not (false). | OptionsValueObject | ||
| showHierarchyCaptions : Boolean
Indicates whether the hierarchy captions are visible (true) or not (false) on the grid. | OptionsValueObject | ||
| showMemberProperties : Boolean
Indicates whether the member properties for OLAP data source are visible (true) or not (false) on Fields List. | OptionsValueObject | ||
| showReportFiltersArea : Boolean
Indicates whether the reports filtering cells on the grid should be visible (true) or not (false). | OptionsValueObject | ||
| showTotals : Boolean
Indicates whether the totals are visible (true) or not (false). | OptionsValueObject | ||
| sorting : String
Indicates whether the sorting controls are visible in rows ("rows"), in columns ("columns"), in rows and columns ("on" or true) on the grid cells or not visible ("off" or false). | OptionsValueObject | ||
| useOlapFormatting : Boolean
Indicates whether the values from MSAS data source will be formatted according to the format defined in the cube (true) or not (false). | OptionsValueObject | ||
| viewType : String
Type of view to show: ViewType.GRID, ViewType.CHARTS or ViewType.GRID_CHARTS (starting from v1.9). | OptionsValueObject | ||
| chartAutoRange | property |
chartAutoRange:BooleanIndicates whether the range of values on the charts is selected automatically or not. Default value is false.
public function get chartAutoRange():Boolean public function set chartAutoRange(value:Boolean):void| chartMultipleMeasures | property |
chartMultipleMeasures:BooleanIndicates whether to show multiple measures on charts. Default value is false.
public function get chartMultipleMeasures():Boolean public function set chartMultipleMeasures(value:Boolean):void| chartType | property |
chartType:StringSelected chart type. The following chart types are supported: ChartType.BAR, ChartType.LINE, ChartType.SCATTER, ChartType.PIE, ChartType.BAR_STACK and ChartType.BAR_LINE (starting from v1.9). Default is ChartType.BAR.
public function get chartType():String public function set chartType(value:String):void| classicView | property |
classicView:BooleanDefines whether pivot table should be shown in the classic view (true) or not (false). Default value is false, which means that classic view is turned off.
public function get classicView():Boolean public function set classicView(value:Boolean):void| configuratorActive | property |
configuratorActive:BooleanIndicates whether the Fields List is opened (true) or closed (false).
public function get configuratorActive():Boolean public function set configuratorActive(value:Boolean):void| configuratorButton | property |
configuratorButton:BooleanIndicates whether the Fields List toggle button is visible (true) or not (false).
public function get configuratorButton():Boolean public function set configuratorButton(value:Boolean):void| configuratorMatchHeight | property |
configuratorMatchHeight:BooleanIndicates whether the Fields List will be the same height as the component (true) or it's height will be defined by its content amount (false). Default value is false.
public function get configuratorMatchHeight():Boolean public function set configuratorMatchHeight(value:Boolean):void| datePattern | property |
datePattern:StringDefault value is "dd/MM/yyyy".
public function get datePattern():String public function set datePattern(value:String):void| drillThrough | property |
drillThrough:BooleanIndicates whether the drill through feature is enabled (true) or disabled (false). User can drill through by double-clicking the cell with value. This feature is available for CSV data sources only. Default value is true.
public function get drillThrough():Boolean public function set drillThrough(value:Boolean):void| editing | property |
editing:BooleanIndicates whether the editing feature is enabled (true) or disabled (false) on the Drill Through popup for CSV data sources. User will be able to double-click the cell and enter new value in it if the editing feature is enabled. This feature is available for CSV data sources only. Default value is false.
public function get editing():Boolean public function set editing(value:Boolean):void| fitGridlines | property |
fitGridlines:BooleanIndicates whether the gridlines are shown for all cells (false) or only non-empty (true).
public function get fitGridlines():Boolean public function set fitGridlines(value:Boolean):void| flatView | property |
flatView:BooleanDefines whether data should be shown in the flat view (true) or not (false). Default value is false, which means that flat view is turned off.
public function get flatView():Boolean public function set flatView(value:Boolean):void| htmlFooter | property |
htmlFooter:StringFooter in HTML format which is added to exported HTML.
public function get htmlFooter():String public function set htmlFooter(value:String):void| htmlHeader | property |
htmlHeader:StringHeader in HTML format which is added to exported HTML. The following tokens can be used: ##TITLE##, ##CURRENT-DATE##. They will be replaced by appropriate data.
public function get htmlHeader():String public function set htmlHeader(value:String):void| ignoreQuotedLineBreaks | property |
ignoreQuotedLineBreaks:BooleanIndicates whether the line breaks in quotes will be ignored (true) in CSV files or not (false). Default value is true, which makes CSV parsing faster. Set it to false only if your data source has valuable for you line breaks in quotes. Please note that this might slow down CSV parsing a little bit.
public function get ignoreQuotedLineBreaks():Boolean public function set ignoreQuotedLineBreaks(value:Boolean):void| pdfFontUrl | property |
pdfFontUrl:StringSpecifies the path to the external font (TTF) which will be used during exporting to PDF. This is optional. Default value is "".
public function get pdfFontUrl():String public function set pdfFontUrl(value:String):void| pdfFooter | property |
pdfFooter:StringFooter in HTML format (only limited amount of tags are supported: div, p, span, br, img with base64 src, some basic inline styles) which is added to each page of exported PDF. The following tokens can be used: ##TITLE##, ##CURRENT-DATE##, ##PAGE-NUMBER##, ##TOTAL-PAGES##. They will be replaced by appropriate data.
public function get pdfFooter():String public function set pdfFooter(value:String):void| pdfHeader | property |
pdfHeader:StringHeader in HTML format (only limited amount of tags are supported: div, p, span, br, img with base64 src, some basic inline styles) which is added to each page of exported PDF. The following tokens can be used: ##TITLE##, ##CURRENT-DATE##, ##PAGE-NUMBER##, ##TOTAL-PAGES##. They will be replaced by appropriate data.
public function get pdfHeader():String public function set pdfHeader(value:String):void| showAggregations | property |
showAggregations:BooleanIndicates whether the aggregation selection control is visible (true) or not (false) for measures on Fields List. Default value is true.
public function get showAggregations():Boolean public function set showAggregations(value:Boolean):void| showCalculatedValuesButton | property |
showCalculatedValuesButton:BooleanDefines the visibility of "Add calculated value" link in Fields List. Default value is true.
public function get showCalculatedValuesButton():Boolean public function set showCalculatedValuesButton(value:Boolean):void| showChartLegendButton | property |
showChartLegendButton:BooleanIndicates whether the button to show/hide the legend on charts is visible. Default value is false which means that the legend is always visible, without the button that hides it.
public function get showChartLegendButton():Boolean public function set showChartLegendButton(value:Boolean):void| showChartMeasures | property |
showChartMeasures:BooleanIndicates whether all dropdowns on the top of charts are visible (true) or not (false). The property can be used to show simple chart without controls or when you want to save space. The dropdowns are visible by default (true).
public function get showChartMeasures():Boolean public function set showChartMeasures(value:Boolean):void| showChartsWarning | property |
showChartsWarning:BooleanIndicates whether the warning are shown if data is too big for charts. Default is true.
public function get showChartsWarning():Boolean public function set showChartsWarning(value:Boolean):void| showDefaultSlice | property |
showDefaultSlice:BooleanDefines whether the component selects a default slice for the report with empty slice (when nothing is set in rows, columns, pages and measures). If true, the first hierarchy from data goes to rows and the first measure goes to columns in the default slice. To avoid this default behavior, please set this property to false. Default value is true.
public function get showDefaultSlice():Boolean public function set showDefaultSlice(value:Boolean):void| showFilter | property |
showFilter:BooleanIndicates whether the opening columns/rows filter controls and page filter controls are visible (true) or not (false) on the grid. Default value is true.
public function get showFilter():Boolean public function set showFilter(value:Boolean):void| showFilterInCharts | property |
showFilterInCharts:BooleanIndicates whether the opening columns and rows filter controls are visible (true) or not (false) on the charts. Default value is true.
public function get showFilterInCharts():Boolean public function set showFilterInCharts(value:Boolean):void| showFiltersExcel | property |
showFiltersExcel:BooleanIndicates whether the filters info will be shown (true) in exported Excel file or not (false). Default value is false.
public function get showFiltersExcel():Boolean public function set showFiltersExcel(value:Boolean):void| showGrandTotals | property |
showGrandTotals:StringSpecifies how to show grand totals: in rows ("rows"), in columns ("columns"), in rows and columns ("on") or hide them ("off"). Default value is "on".
public function get showGrandTotals():String public function set showGrandTotals(value:String):void| showHeaders | property |
showHeaders:BooleanIndicates whether the spreadsheet headers are visible (true) or not (false).
public function get showHeaders():Boolean public function set showHeaders(value:Boolean):void| showHierarchyCaptions | property |
showHierarchyCaptions:BooleanIndicates whether the hierarchy captions are visible (true) or not (false) on the grid. Default value is true.
public function get showHierarchyCaptions():Boolean public function set showHierarchyCaptions(value:Boolean):void| showMemberProperties | property |
showMemberProperties:BooleanIndicates whether the member properties for OLAP data source are visible (true) or not (false) on Fields List. Default value is false.
public function get showMemberProperties():Boolean public function set showMemberProperties(value:Boolean):void| showReportFiltersArea | property |
showReportFiltersArea:BooleanIndicates whether the reports filtering cells on the grid should be visible (true) or not (false). Default value is true.
public function get showReportFiltersArea():Boolean public function set showReportFiltersArea(value:Boolean):void| showTotals | property |
showTotals:BooleanIndicates whether the totals are visible (true) or not (false). Default value is true.
public function get showTotals():Boolean public function set showTotals(value:Boolean):void| sorting | property |
sorting:StringIndicates whether the sorting controls are visible in rows ("rows"), in columns ("columns"), in rows and columns ("on" or true) on the grid cells or not visible ("off" or false). Default value is "on".
public function get sorting():String public function set sorting(value:String):void| useOlapFormatting | property |
useOlapFormatting:BooleanIndicates whether the values from MSAS data source will be formatted according to the format defined in the cube (true) or not (false). Default value is false.
public function get useOlapFormatting():Boolean public function set useOlapFormatting(value:Boolean):void| viewType | property |
viewType:StringType of view to show: ViewType.GRID, ViewType.CHARTS or ViewType.GRID_CHARTS (starting from v1.9). Default value is ViewType.GRID.
public function get viewType():String public function set viewType(value:String):void