Difference between revisions of "Tabulation getDefaultDiagramStyle"

From Catglobe Wiki
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
−
[[Category:Style setting functions]]
 
−
{{HelpFiles}}
 
  
−
=====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_|DiagramFillStyle_getDefault]] and [[_DiagramFontStyle_getDefault_|DiagramFontStyle_getDefault]].
+
===== Tabulation_getDefaultDiagramStyle  =====
  
−
'''Syntax'''
+
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|DiagramFillStyle_getDefault]] and [[DiagramFontStyle getDefault|DiagramFontStyle_getDefault]].
  
−
Tabulation_getDefaultDiagramStyle(''number'')
+
'''Syntax'''  
  
−
'''Arguments'''
+
Tabulation_getDefaultDiagramStyle(''number'')
  
−
''number'': enumeration for diagram type.
+
or can use [[TabulationDiagramStyle_class|new TabulationDiagramStyle();]]
  
−
Currently, only one diagram type is supported, table diagram (diagram type = 1).
+
'''Arguments'''
  
−
More diagram type will be supported in the future.
+
''number'': enumeration for diagram type.  
  
−
'''Return type'''
+
Currently, only one diagram type is supported, table diagram (diagram type = 1).
  
−
Returns the following array
+
More diagram type will be supported in the future.
  
−
{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="907" border="1" cellpadding="2"
+
'''Return type'''
 +
 
 +
Returns the following array
 +
 
 +
{| cellpadding="2" border="1" width="907" style="border-collapse: collapse; border: 1px solid rgb(1, 1, 1);" class="tableintopic"
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
Constant
+
Constant  
−
| style="border: 1px solid #010101" width="73" bgcolor="#F59D56" |
+
 
−
Type
+
| bgcolor="#f59d56" width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" bgcolor="#F59D56" |
+
Type  
−
Initial/Default value
+
 
−
| style="border: 1px solid #010101" width="433" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Description
+
Initial/Default value  
 +
 
 +
| bgcolor="#f59d56" width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Description  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
OBJECT_TYPE
+
OBJECT_TYPE  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Number
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Number  
−
21
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Enumeration defining the object type.
+
21  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Enumeration defining the object type.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_FILL
+
TABLE_DIAGRAM_STYLE_FILL  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Array
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Array  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Fill style. Background color.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Fill style. Background color.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_DECIMAL
+
TABLE_DIAGRAM_STYLE_DECIMAL  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Number
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Number  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Decimal place.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Decimal place.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_FONT
+
TABLE_DIAGRAM_STYLE_FONT  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Array
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Array  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_VALIGN
+
TABLE_DIAGRAM_STYLE_VALIGN  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
String
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
String  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Vertical alignment (allows values "top", "center", or "bottom").
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Vertical alignment (allows values "top", "center", or "bottom").  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_HALIGN
+
TABLE_DIAGRAM_STYLE_HALIGN  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
String
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
String  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Horizontal alignment (allows values "left", "center", or "right").
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Horizontal alignment (allows values "left", "center", or "right").  
 +
 
 +
|}
 +
 
 +
'''Examples'''
 +
 
 +
''array tablediagram = Tabulation_getDefaultDiagramStyle(1); ''
 +
 
 +
''print(tablediagram);''
 +
 
 +
''//Result: (e.g: {21,{19,{17,255,255,255},2,False},1,{18,Arial,10,{17,255,255,255},False,False,False,False},Center,Left})''
 +
 
 +
'''Availability'''
  
−
'''Examples'''
+
Version 5.8.1 __NOTOC__ <!-- imported from file: 8100.htm-->
  
−
array tablediagram = Tabulation_getDefaultDiagramStyle(1);
 
  
−
'''Availability'''
 
  
−
Version 5.8.1
+
[[Category:Style_setting_functions]]
−
__NOTOC__
 
−
<!-- imported from file: 8100.htm-->
 

Latest revision as of 07:58, 22 September 2023


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)

or can use new TabulationDiagramStyle();

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);

print(tablediagram);

//Result: (e.g: {21,{19,{17,255,255,255},2,False},1,{18,Arial,10,{17,255,255,255},False,False,False,False},Center,Left})

Availability

Version 5.8.1

Retrieved from "http://wiki.catglobe.com/index.php?title=Tabulation_getDefaultDiagramStyle&oldid=240901"