Difference between revisions of "Tabulation getDefaultDiagramStyle"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
[[Category:Style setting functions]]
 
[[Category:Style setting functions]]

+
{{HelpFiles}}
  
 
=====Tabulation_getDefaultDiagramStyle=====
 
=====Tabulation_getDefaultDiagramStyle=====

Revision as of 11:13, 12 December 2011



Tabulation_getDefaultDiagramStyle

Gets a default chart style object that can then be used for setting styles for entire charts. The default settings are derived from the systems set default style sheet. Since this is defined when setting up the system, these help files cannot tell you what the actual default values for your site willl be. As you will see, this object will include both the default fill style and font style objects for a chart, that can also be extracted individually using the functions DiagramFillStyle_getDefault and DiagramFontStyle_getDefault.

Syntax

Tabulation_getDefaultDiagramStyle(number)

Arguments

number: enumeration for diagram type.

Currently, only one diagram type is supported, table diagram (diagram type = 1).

More diagram type will be supported in the future.

Return type

Returns the following array

Constant

Type

Initial/Default value

Description

OBJECT_TYPE

Number

21

Enumeration defining the object type.

TABLE_DIAGRAM_STYLE_FILL

Array

Default extracted from system's default style sheet.

Fill style. Background color.

TABLE_DIAGRAM_STYLE_DECIMAL

Number

Default extracted from system's default style sheet.

Decimal place.

TABLE_DIAGRAM_STYLE_FONT

Array

Default extracted from system's default style sheet.

Font.

TABLE_DIAGRAM_STYLE_VALIGN

String

Default extracted from system's default style sheet.

Vertical alignment (allows values "top", "center", or "bottom").

TABLE_DIAGRAM_STYLE_HALIGN

String

Default extracted from system's default style sheet.

Horizontal alignment (allows values "left", "center", or "right").

Examples

array tablediagram = Tabulation_getDefaultDiagramStyle(1);

Availability

Version 5.8.1