Difference between revisions of "DiagramFontStyle getDefault"

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

 
  
−
=====DiagramFontStyle_getDefault=====
+
===== DiagramFontStyle_getDefault =====
  
−
Gets a default chart chart font 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 chart font 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'''  
  
−
DiagramFontStyle_getDefault()
+
DiagramFontStyle_getDefault()  
  
−
'''Arguments'''
+
or can use [[TabulationTextStyle_class|TabulationTextStyle]]
  
−
''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" 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="222" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" align="center" width="222" valign="middle" style="border: 1px solid rgb(1, 1, 1);" |  
−
Constant
+
'''Constant'''
−
| style="border: 1px solid #010101" width="96" bgcolor="#F59D56" |
+
 
−
Type
+
| bgcolor="#f59d56" align="center" width="96" valign="middle" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" bgcolor="#F59D56" |
+
'''Type'''
−
Initial/Default value
+
 
−
| style="border: 1px solid #010101" width="433" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" align="center" width="156" valign="middle" style="border: 1px solid rgb(1, 1, 1);" |  
−
Description
+
'''Initial/Default value'''
 +
 
 +
| bgcolor="#f59d56" align="center" width="433" 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="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
OBJECT_TYPE
+
OBJECT_TYPE  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Number
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Number  
−
18
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Enumeration for the object type.
+
18  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Enumeration for the object type.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_FACE
+
DIAGRAM_FONT_STYLE_FACE  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
String
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
String  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font face. Currently, the system supports the following font face: arial, courier new, lucida sans unicode, ms sans serif, tahoma, verdana, arial black, arial narrow, comic sans ms, wingdings, kantipur.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font face. Currently, the system supports the following font face: arial, courier new, lucida sans unicode, ms sans serif, tahoma, verdana, arial black, arial narrow, comic sans ms, wingdings, kantipur.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_SIZE
+
DIAGRAM_FONT_STYLE_SIZE  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Number
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Number  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font size.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font size.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_COLOR
+
DIAGRAM_FONT_STYLE_COLOR  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Array
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Array  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font color.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font color.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_BOLD
+
DIAGRAM_FONT_STYLE_BOLD  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Boolean
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Boolean  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font style: bold.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font style: bold.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_ITALIC
+
DIAGRAM_FONT_STYLE_ITALIC  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Boolean
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Boolean  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font style: italic.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font style: italic.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_UNDERLINE
+
DIAGRAM_FONT_STYLE_UNDERLINE  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Boolean
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Boolean  
−
Default extracted from system's default style sheet.
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font style: underline.
+
Default extracted from system's default style sheet.  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font style: underline.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="222" |
+
| width="222" style="border: 1px solid rgb(1, 1, 1);" |  
−
DIAGRAM_FONT_STYLE_INHERIT
+
DIAGRAM_FONT_STYLE_INHERIT  
−
| style="border: 1px solid #010101" width="96" |
+
 
−
Boolean
+
| width="96" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="156" |
+
Boolean  
−
False
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="156" 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 font = DiagramFontStyle_getDefault();''
 +
 
 +
''print(font);''
 +
 
 +
''//Result: (e.g: {18,Arial,10,{17,255,255,255},False,False,False,False})''
  
−
'''Examples'''
+
''{{note}} This function should be paired with create diagram functions''  
  
−
''array font = DiagramFontStyle_getDefault();''
+
'''Availability'''  
  
−
'''Availability'''
+
Version 5.8.1 __NOTOC__ <!-- imported from file: 8098.htm-->
  
−
Version 5.8.1
+
[[Category:Style_setting_functions]]
−
__NOTOC__
 
−
<!-- imported from file: 8098.htm-->
 

Latest revision as of 08:14, 22 September 2023



DiagramFontStyle_getDefault

Gets a default chart chart font 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

DiagramFontStyle_getDefault()

or can use TabulationTextStyle

Arguments

None

Return type

Returns the following array

Constant

Type

Initial/Default value

Description

OBJECT_TYPE

Number

18

Enumeration for the object type.

DIAGRAM_FONT_STYLE_FACE

String

Default extracted from system's default style sheet.

Font face. Currently, the system supports the following font face: arial, courier new, lucida sans unicode, ms sans serif, tahoma, verdana, arial black, arial narrow, comic sans ms, wingdings, kantipur.

DIAGRAM_FONT_STYLE_SIZE

Number

Default extracted from system's default style sheet.

Font size.

DIAGRAM_FONT_STYLE_COLOR

Array

Default extracted from system's default style sheet.

Font color.

DIAGRAM_FONT_STYLE_BOLD

Boolean

Default extracted from system's default style sheet.

Font style: bold.

DIAGRAM_FONT_STYLE_ITALIC

Boolean

Default extracted from system's default style sheet.

Font style: italic.

DIAGRAM_FONT_STYLE_UNDERLINE

Boolean

Default extracted from system's default style sheet.

Font style: underline.

DIAGRAM_FONT_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 font = DiagramFontStyle_getDefault();

print(font);

//Result: (e.g: {18,Arial,10,{17,255,255,255},False,False,False,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=DiagramFontStyle_getDefault&oldid=240904"