Difference between revisions of "Tabulation setTableDiagramStyle"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
== Return type<br/> ==
+
[[Category:Style_setting_functions]]
 +
{{HelpFiles}}
  
Returns the following array
+
===Tabulation_setTableDiagramStyle===)
  
{| class="tableintopic" style="border-collapse: collapse;  border: 1px solid rgb(1, 1, 1)" border="1" cellpadding="2" width="958"
+
Put the function description here
|- align="left" valign="top"
+
Example: Return value property of question.
| style="border: 1px solid #010101" bgcolor="#F59D56" width="227" | <p style="text-align: center">tableDiagramStyle</p>
+
 
| style="border: 1px solid #010101" bgcolor="#F59D56" width="227" | <p style="text-align: center">Constant</p>
+
===Syntax===
| style="border: 1px solid #010101" bgcolor="#F59D56" width="73" | <p style="text-align: center">Type</p>
 
| style="border: 1px solid #010101" bgcolor="#F59D56" width="174" | <p style="text-align: center">Initial/Default value</p>
 
| style="border: 1px solid #010101" bgcolor="#F59D56" width="433" | <p style="text-align: center">Description</p>
 
|- align="left" valign="top"
 
| colspan="1" rowspan="3" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_FILL<br/>
 
| style="border: 1px solid #010101" width="227" |
 
DIAGRAM_FILL_STYLE_COLOR
 
  
| style="border: 1px solid #010101" width="73" |
+
Tabulation_setTableDiagramStyle(styleType, tableDiagramStyle, argTableDiagramStyle);
Array
 
  
| style="border: 1px solid #010101" width="174" |
+
===Arguments===
Default extracted from system's default style sheet.
 
  
| style="border: 1px solid #010101" width="433" |
+
styleType: is the CELL type that will be affected by the call. It's the value of the Table diagram constants. Or we can also use the name of Table Diagram constants
Fill style. Background color.
+
tableDiagramStyle: is the kind of style. It's the value of the Table Diagram style constants. Or we can also use the name of Table Diagram style constants
  
|-
+
argTableDiagramStyle: is argument for the given tableDiagramStyle
| style="border: 1px solid #010101" width="227" | DIAGRAM_FILL_STYLE_TYPE<br/>
+
{| class="tableintopic" style="border-collapse: collapse;  border: 1px solid rgb(1, 1, 1)" border="1" cellpadding="2" width="958"
| style="border: 1px solid #010101" width="73" |  
+
|- align="left" valign="top"
Number
+
| style="border: 1px solid #010101" bgcolor="#F59D56" width="227" |  
 +
tableDiagramStyle
  
| style="border: 1px solid #010101" width="174" | Default extracted from system's default style sheet<br/>
+
| style="border: 1px solid #010101" bgcolor="#F59D56" width="73" |  
| style="border: 1px solid #010101" width="433" |  
+
Type
Fill type. Enumeration. Either 1: Diagram_Fill_Style_NoFill or 2: Diagram_Fill_Style_Fill
 
  
|-
+
| style="border: 1px solid #010101" bgcolor="#F59D56" width="433" |  
| style="border: 1px solid #010101" width="73" | DIAGRAM_FILL_STYLE_INHERIT<br/>
+
Description
| style="border: 1px solid #010101" width="174" |  
 
Boolean
 
  
| style="border: 1px solid #010101" width="433" | False<br/>
 
| Specifies whether the font style will be inherited from the style sheet (when True) or gotten from the system's default (when False).<br/>
 
|-
 
| colspan="1" rowspan="7" style="border: 1px solid #010101" width="73" | TABLE_DIAGRAM_STYLE_FONT<br/>
 
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_FACE<br/>
 
| style="border: 1px solid #010101" width="433" | String<br/>
 
| style="border: 1px solid #010101" width="433" | Default extracted from system's default style sheet.<br/>
 
| 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.<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_SIZE<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_FILL<br/>
| style="border: 1px solid #010101" width="433" | Number<br/>
+
| style="border: 1px solid #010101" width="73" | array<br/>
| style="border: 1px solid #010101" width="433" | Default extracted from system's default style sheet.<br/>
+
| style="border: 1px solid #010101" width="433" | Is the array of function [http://wiki.catglobe.com/index.php/DiagramFillStyle_getDefault DiagramFillStyle_getDefault]<br/>
| Font size.<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_COLOR<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_DECIMAL<br/>
| style="border: 1px solid #010101" width="433" | Array<br/>
+
| style="border: 1px solid #010101" width="174" | number<br/>
| style="border: 1px solid #010101" width="433" | Default extracted from system's default style sheet.<br/>
+
| With min 0<br/>
| Font color.<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_BOLD<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_FONT<br/>
| style="border: 1px solid #010101" width="433" | Boolean<br/>
+
| style="border: 1px solid #010101" width="174" | array<br/>
| style="border: 1px solid #010101" width="433" | Default extracted from system's default style sheet.<br/>
+
| Is the array of function [http://wiki.catglobe.com/index.php/DiagramFontStyle_getDefault DiagramFontStyle_getDefault]<br/>
| Font style: bold.<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_ITALIC<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_VALIGN<br/>
| style="border: 1px solid #010101" width="433" | Boolean<br/>
+
| style="border: 1px solid #010101" width="174" | string<br/>
| style="border: 1px solid #010101" width="433" | Default extracted from system's default style sheet.<br/>
+
| takes string values of these Center, Left, Right<br/>
| Font style: italic.<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_UNDERLINE<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_HALIGN<br/>
| style="border: 1px solid #010101" width="433" | Boolean<br/>
+
| style="border: 1px solid #010101" width="174" | string<br/>
| style="border: 1px solid #010101" width="433" | Default extracted from system's default style sheet.<br/>
+
| takes string values of these Center, Left, Right<br/>
| Font style: underline.<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="174" | DIAGRAM_FONT_STYLE_INHERIT<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_NUMBER_FORMATTER<br/>
| style="border: 1px solid #010101" width="433" | Boolean<br/>
+
| style="border: 1px solid #010101" width="174" | string<br/>
| style="border: 1px solid #010101" width="433" | False<br/>
+
| takes a string.format string, default is "{0:"+decimalplaces+"}"<br/>
| Specifies whether the font style will be inherited from the style sheet (when True) or gotten from the system's default (when False).<br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="73" | TABLE_DIAGRAM_STYLE_VALIGN<br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_PERCENT_FORMATTER<br/>
| style="border: 1px solid #010101" width="174" | <br/>
+
| style="border: 1px solid #010101" width="174" | string<br/>
| style="border: 1px solid #010101" width="433" | <br/>
+
| takes a string.format string, default is "{0:"+decimalplaces+"}%"<br/>
| style="border: 1px solid #010101" width="433" | <br/>
 
| <br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="73" | <br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_SIGNIFICANCE_FORMATTER<br/>
| style="border: 1px solid #010101" width="174" | <br/>
+
| style="border: 1px solid #010101" width="174" | string<br/>
| style="border: 1px solid #010101" width="433" | <br/>
+
| takes a string.format string, default is "{0:[+];[-];,} {1}"<br/>where 0 is int that is positive, negative or zero depending on significance and 1 is the Z value<br/>
| style="border: 1px solid #010101" width="433" | <br/>
 
| <br/>
 
 
|-
 
|-
| style="border: 1px solid #010101" width="73" | <br/>
+
| colspan="1" style="border: 1px solid #010101" width="227" | TABLE_DIAGRAM_STYLE_BORDER_STYLE<br/>
| style="border: 1px solid #010101" width="174" | <br/>
+
| style="border: 1px solid #010101" width="174" | object<br/>
| style="border: 1px solid #010101" width="433" | <br/>
+
| takes a [http://wiki.catglobe.com/index.php/TabulationBorder_class Border object]<br/>
| style="border: 1px solid #010101" width="433" | <br/>
 
| <br/>
 
 
|}
 
|}
 +
 +
===Return type===
 +
 +
Empty
 +
 +
===Examples===
 +
<source lang="javascript">
 +
  Put your cgs codes and results here
 +
</source>
 +
__NOTOC__

Revision as of 09:13, 7 December 2015



===Tabulation_setTableDiagramStyle===)

Put the function description here Example: Return value property of question.

Syntax

Tabulation_setTableDiagramStyle(styleType, tableDiagramStyle, argTableDiagramStyle);

Arguments

styleType: is the CELL type that will be affected by the call. It's the value of the Table diagram constants. Or we can also use the name of Table Diagram constants tableDiagramStyle: is the kind of style. It's the value of the Table Diagram style constants. Or we can also use the name of Table Diagram style constants

argTableDiagramStyle: is argument for the given tableDiagramStyle

tableDiagramStyle

Type

Description

TABLE_DIAGRAM_STYLE_FILL
array
Is the array of function DiagramFillStyle_getDefault
TABLE_DIAGRAM_STYLE_DECIMAL
number
With min 0
TABLE_DIAGRAM_STYLE_FONT
array
Is the array of function DiagramFontStyle_getDefault
TABLE_DIAGRAM_STYLE_VALIGN
string
takes string values of these Center, Left, Right
TABLE_DIAGRAM_STYLE_HALIGN
string
takes string values of these Center, Left, Right
TABLE_DIAGRAM_STYLE_NUMBER_FORMATTER
string
takes a string.format string, default is "{0:"+decimalplaces+"}"
TABLE_DIAGRAM_STYLE_PERCENT_FORMATTER
string
takes a string.format string, default is "{0:"+decimalplaces+"}%"
TABLE_DIAGRAM_STYLE_SIGNIFICANCE_FORMATTER
string
takes a string.format string, default is "{0:[+];[-];,} {1}"
where 0 is int that is positive, negative or zero depending on significance and 1 is the Z value
TABLE_DIAGRAM_STYLE_BORDER_STYLE
object
takes a Border object

Return type

Empty

Examples

  Put your cgs codes and results here