Difference between revisions of "DiagramFillStyle getDefault"

From Catglobe Wiki
Jump to: navigation, search
(jrfconvert import)
 
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:HelpBooks]]
+
{{HelpFiles}}
−

 
  
−
=====DiagramFillStyle_getDefault=====
+
===== DiagramFillStyle_getDefault =====
  
−
Gets a default chart fill style object that can then be used for setting styles for various parts of 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.
+
Gets a default chart fill style object that can then be used for setting styles for various parts of 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.  
  
−
'''Syntax'''
+
'''Syntax'''  
  
−
DiagramFillStyle_getDefault()
+
DiagramFillStyle_getDefault()  
  
−
'''Arguments'''
+
or can use [[TabulationFillStyle_class|TabulationFillStyle]]
  
−
''None''
+
'''Arguments'''  
  
−
'''Return type'''
+
''None''  
  
−
Returns the following array
+
'''Return type'''
  
−
{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="907" border="1" cellpadding="2"
+
Returns the following array
 +
 
 +
{| cellpadding="2" border="1" width="907" class="tableintopic" style="border-collapse: collapse; border: 1px solid rgb(1, 1, 1);"
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" align="center" width="227" valign="middle" style="border: 1px solid rgb(1, 1, 1);" |  
−
Constant
+
'''Constant'''
−
| style="border: 1px solid #010101" width="73" bgcolor="#F59D56" |
+
 
−
Type
+
| bgcolor="#f59d56" align="center" width="227" valign="middle" 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" align="center" width="227" valign="middle" style="border: 1px solid rgb(1, 1, 1);" |  
−
Description
+
'''Initial/Default value'''
 +
 
 +
| bgcolor="#f59d56" align="center" width="227" valign="middle" 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  
−
19
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Enumeration defining the object type.
+
19  
 +
 
 +
| 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);" |  
−
DIAGRAM_FILL_STYLE_COLOR
+
DIAGRAM_FILL_STYLE_COLOR  
−
| 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);" |  
−
Background color.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
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);" |  
−
DIAGRAM_FILL_STYLE_TYPE
+
DIAGRAM_FILL_STYLE_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  
−
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 type. Enumeration. Either 1: Diagram_Fill_Style_NoFill or 2: Diagram_Fill_Style_Fill
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Fill type. Enumeration. Either 1: Diagram_Fill_Style_NoFill or 2: Diagram_Fill_Style_Fill  
 +
 
 
|- 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);" |  
−
DIAGRAM_FILL_STYLE_INHERIT
+
DIAGRAM_FILL_STYLE_INHERIT  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Boolean
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Boolean  
−
False
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Specifies whether the font style will be inherited from the style sheet (when True) or gotten from the system's default (when False).
+
False  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Specifies whether the font style will be inherited from the style sheet (when True) or gotten from the system's default (when False).  
 +
 
 +
|}
 +
 
 +
'''Examples'''
 +
 
 +
''array fill = DiagramFillStyle_getDefault(); ''
 +
 
 +
''print(fill);''
 +
 
 +
''//Result: (e.g: {19,{17,255,255,255},2,False})''
  
−
'''Examples'''
+
''{{note}} This function should be paired with create diagram functions''  
  
−
array fill = DiagramFillStyle_getDefault();
+
'''Availability'''
  
−
'''Availability'''
+
Version 5.8.1 __NOTOC__ <!-- imported from file: 8099.htm-->
  
−
Version 5.8.1
+
[[Category:Style_setting_functions]]
−
__NOTOC__
 
−
<!-- imported from file: 8099.htm-->
 

Latest revision as of 09:15, 22 September 2023



DiagramFillStyle_getDefault

Gets a default chart fill style object that can then be used for setting styles for various parts of 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.

Syntax

DiagramFillStyle_getDefault()

or can use TabulationFillStyle

Arguments

None

Return type

Returns the following array

Constant

Type

Initial/Default value

Description

OBJECT_TYPE

Number

19

Enumeration defining the object type.

DIAGRAM_FILL_STYLE_COLOR

Array

Default extracted from system's default style sheet.

Background color.

DIAGRAM_FILL_STYLE_TYPE

Number

Default extracted from system's default style sheet.

Fill type. Enumeration. Either 1: Diagram_Fill_Style_NoFill or 2: Diagram_Fill_Style_Fill

DIAGRAM_FILL_STYLE_INHERIT

Boolean

False

Specifies whether the font style will be inherited from the style sheet (when True) or gotten from the system's default (when False).

Examples

array fill = DiagramFillStyle_getDefault();

print(fill);

//Result: (e.g: {19,{17,255,255,255},2,False})

Note Note: This function should be paired with create diagram functions

Availability

Version 5.8.1

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