Trellis
Trellis Support
V3.5 QFE is required for Trellis charts. Attempting to create a Trellis chart through the DashAPI with Row64 Server V3.5 will result in a blank dashboard pane.
Required Components
Adding a Venn diagram requires the following components:
tDef = []- A list that establishes the chart's name, labels, values, and index value, based on the underlying dataframe or data node.
tOptions = []- A list of format options that changes the visual appearance of the chart.
dash.add_trellis()- The function that places the chart on a designated pane. The structure and formatting lists are passed into this function.
Note that the definition and options lists are simply Python lists and that their variable names can change.
Components Syntax
tDef
tDef = [
[ "NAME", "LABELS", "VALUES", "INDEX_VALUE" ],
]
The tDef ("Trellis definition") list establishes the chart's overall structure by defining the chart's values and labels.
"NAME"- A name for the series.
"LABELS"- A cell range that defines labels.
- Example:
"=DNode2!A:A"
"VALUES"- A cell range that defines chart values.
- Example:
"=DNode2!C:C"
"INDEX_VALUE"- A cell range that defines the index value.
- Example:
"=DNode2!B:B"
tOptions
tOptions = [
["Series", 0 ,"Line","Color",0xed1851],
["Series", 1 ,"Line","Color",0x0076bd],
...
]
The tOptions list is a list of formatting options that changes the appearance of the chart. Each formatting item is enclosed in brackets [ ... ] and separated by commas. A full list of formatting options is available in the Trellis Chart Format Options section.
dash.add_trellis()
dash.add_trellis("TYPE", "CHART_NAME", "PANE_NAME", tDef, tOptions)
The dash.add_pie() function adds the chart to a designated dashboard pane. This function takes the chart's name, the destination pane's name, and the definition and formatting lists as arguments.
"TYPE"- Indicates the Trellis type.
- Example:
"Line"
"CHART_NAME"- The name you want to give the chart.
"PANE_NAME"- The name of a pane from the pane list (
pList) that the chart should be placed on. The name provided for this argument should match a pane name from the pane list.
- The name of a pane from the pane list (
tDef- The definition list, which defines the chart's values and labels.
tOptions- The options list, which defines the chart's visual appearance and formatting.
Supported Types
For the TYPE argument, only "Line" is currently supported. More types will become available in future versions of the Row64 platform.
Code Example
# Module import
from row64tools.dash64 import dash64
# Dashboard save path
dash = dash64("/var/www/dashboards/temp/trellis.dash")
# Establish dashboard panes
pList = [
["Dashboard", "", "1600", "900", "y"],
["TopPane", "Dashboard", "*", "*", ""],
["BottomPane", "Dashboard", "*", "20%", ""]
]
dash.Layout.set_panes(pList)
# Add and format a dataframe
dash.add_ramdb("/var/www/ramdb/live/RAMDB.Row64/Examples/Seasonal.ramdb","DF1")
dash.add_df("DF1", "BottomPane")
cWidths = dash.Sheets.Items[ dash.Sheets.get_sheet_ind("DF1") ].ColumnWidths
for i, w in zip([0,1,3,4],[300,300,400,500]):cWidths[i] = w # widen columns
# Add a data node
dnDef2 = [[ "CROSSLINK", ["DF1",0,1,4], [10,8,8,8] ],
[ "GROUPSUM", [0,2], [8,8] ]]
dash.add_datanode("DNode2", "DF1", dnDef2)
# Add another data node
dnDef3 = [[ "CROSSLINK", ["DF1",0,2,4], [10,8,8,8] ],
[ "GROUPSUM", [0,2], [8,8] ]]
dash.add_datanode("DNode3", "DF1", dnDef3)
# Pane formatting
paneDef = [ ["Layout","ShowTitle",False] ] # set the dataframe pane to hide the title
dash.set_pane_def("BottomPane",paneDef)
# Trellis definition list
tDef = [
["", "=DNode2!A:A", "=DNode2!C:C", "=DNode2!B:B" ], # Line Chart Trellis: Name, Labels, Values, Index Value
["", "=DNode3!A:A", "=DNode3!C:C", "=DNode3!B:B" ]
]
# Trellis formatting options list
tOptions = [
["Series", 0 ,"Line","Color",0xed1851],
["Series", 1 ,"Line","Color",0x0076bd],
["Series",0, "Fill","Color",0x3178FA],
["Series",0, "FillType",2],
["Format","Pad",3],
["Format","Line","AxisX","LabelFormat","mm/yy"],
["Format","Line","GridlineX","Type",2], # Categorical:0, Numeric:1, DateTime:2
["Format","Line","GridlineX","AutoMajor",False],
["Format","Line","GridlineX","MajorBase",ord('M')], # uses ASCII value: 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year
["Format","Line","GridlineX","MajorUnit",3]
]
# Add the Trellis to a dashboard pane
dash.add_trellis("Line", "trellis1", "TopPane", tDef, tOptions)
# Save the dashboard
dash.save()
Trellis Chart Format Options
The following tables list the available formatting options for Trellis charts. To format Trellis charts, include formatting items in the tOptions list. Each formatting item should be encapsulated in brackets [ ], and formatting items should be separated by commas. For an example of a tOptions list with multiple formatting items, please see the Code Example above.
General Formatting
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Format","Color" | int - hex color | ["Format","Color",0x000000] | Background Color of the Pane |
| "Format","CrossLinking" | bool | ["Format","CrossLinking",False] | False = Disable Cross filtering for this Pane |
| "Format","Pad" | float | ["Format","Pad",.15] | Percentage of Total Height/Width Padding on Pane |
| "Format","GridType" | int | ["Format","GridType",0] | 0 = 1D Dimensions, 1 = 2D Dimensions |
| "Format","GridLookup" | string | ["Format","GridLookup",0] | link to reference for grid index label lookup |
| "Format","NbRows" | int | ["Format","NbRows",-1] | -1 = auto-fit, positive int values are number of rows |
| "Format","NbCols" | int | ["Format","NbCols",-1] | -1 = auto-fit, positive int values are number of columns |
| "Format","FitW" | bool | ["Format","FitW",True] | Fit Width |
| "Format","FitH" | bool | ["Format","FitH",True] | Fit Height |
| "Format","BoxW" | float | ["Format","BoxW",True] | Width of grid box (content space) |
| "Format","BoxH" | float | ["Format","BoxH",True] | Height of grid box (content space) |
| "Format","Pad" | float | ["Format","Pad",0] | Per chart padding |
| "Format","Mode" | int | ["Format","Mode",0] | Display mode 0 = Trellis, 1 = Panel |
| "Format","ShowOutline" | bool | ["Format","ShowOutline",True] | Show grid boundary outline |
| "Format","Outline","Color" | int - hex color | ["Format","Outline","Color",0xFF000] | Line color of Grid boundary outline |
| "Format","Outline","Size" | float | ["Format","Outline","Size",2.1] | Line size / thickness of Grid boundary outline |
| "Format","Outline","Alpha" | float | ["Format","Outline","Alpha",.5] | Line transparency of Grid boundary outline |
| "Format","RLabelFont","Size" | float | ["Format","RLabelFont","Size",25] | Font size of grid row label |
| "Format","RLabelFont","Color" | int - hex color | ["Format","RLabelFont","Color",0xFF000] | Font Color of grid row label |
| "Format","RLabelFont","Bold" | bool | ["Format","RLabelFont","Bold",True] | Font Bold of grid row label |
| "Format","RLabelFont","Italic" | bool | ["Format","RLabelFont","Italic",True] | Font Italic of grid row label |
| "Format","RLabelFont","Underline" | bool | ["Format","RLabelFont","Underline",True] | Font Underline of grid row label |
| "Format","RLabelFont","Alpha" | float | ["Format","RLabelFont","Alpha",.5] | Font Transparency of grid row label |
| "Format","RLabelRotate" | bool | ["Format","RLabelRotate",True] | Show grid boundary outline |
| "Format","CLabelFont","Size" | float | ["Format","CLabelFont","Size",25] | Font size of grid col label |
| "Format","CLabelFont","Color" | int - hex color | ["Format","CLabelFont","Color",0xFF000] | Font Color of grid col label |
| "Format","CLabelFont","Bold" | bool | ["Format","CLabelFont","Bold",True] | Font Bold of grid col label |
| "Format","CLabelFont","Italic" | bool | ["Format","CLabelFont","Italic",True] | Font Italic of grid col label |
| "Format","CLabelFont","Underline" | bool | ["Format","CLabelFont","Underline",True] | Font Underline of grid col label |
| "Format","CLabelFont","Alpha" | float | ["Format","CLabelFont","Alpha",.5] | Font Transparency of grid col label |
| "Format","CLabelShift" | float | ["Format","CLabelShift",True] | Grid Column Label Shift: 0 = base, < 0 = shift out, > 0 = shift in |
| "Format","Type" | float | ["Format","Type",True] | Chart Type, Currently supports "Line" |
Format Options - Line
(For when the TYPE is "Line").
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Format","Line","Color" | int - hex color | ["Format","Line","Color",0x000000] | Background Color of the Pane |
| "Format","Line","CrossLinking" | bool | ["Format","Line","CrossLinking",False] | False = Disable Cross filtering for this Pane |
| "Format","Line","Pad" | float | ["Format","Line","Pad",.15] | Percentage of Total Height/Width Padding on Pane |
| "Format","Line","LabelShift" | float | ["Format","Line","LabelShift",.3] | Position of Value Labels as a percentage relative to top of bar |
| "Format","Line","ChartPadX" | [float,float] | ["Format","Line","ChartPadX",[.2, .2]] | Bar Chart Left & Right Padding within chart frame. Perc between 0-1 |
| "Format","Line","DataLabelPos" | int | ["Format","Line","DataLabelPos",3] | Label placement relative to points: 0 = none, 1 = right, 2 = left, 3 = top, 4 = bottom |
| "Format","Line","PrimarySep" | int | ["Format","Line","PrimarySep",3] | Primary Seperator Between Label Parts: 0 = none, 1 = comma, 2 = semicolon, 3 = period, 4 = newline, 5 = space |
| "Format","Line","SecondarySep" | int | ["Format","Line","SecondarySep",3] | Secondary Seperator Between Label Parts: 0 = none, 1 = comma, 2 = semicolon, 3 = period, 4 = newline, 5 = space |
| "Format","Line","LabelTypes" | [int,int,int] | ["Format","Line","LabelTypes",[2,0,0]] | Content of Point Label [primary, secondary1, secondary2] where 0 = none, 1 = label, 2 = value |
| "Format","Line","Reverse" | bool | ["Format","Line","Reverse",True] | Reverses primary & secondary order of Labels |
| "Format","Line","FontAlignment" | [float,float] | ["Format","Line","FontAlignment",[0.5,0.6]] | Alignment of Label Text [x alignment, y alignment] between 0 - 1 |
| "Format","Line","InterpolateNull" | bool | ["Format","Line","InterpolateNull",True] | Smooth lines through NULL values |
| "Format","Line","PrimaryFont","Size" | float | ["Format","Line","PrimaryFont","Size",25] | Font size of Primary Label |
| "Format","Line","PrimaryFont","Color" | int - hex color | ["Format","Line","PrimaryFont","Color",0xFF000] | Font Color of Primary Label |
| "Format","Line","PrimaryFont","Bold" | bool | ["Format","Line","PrimaryFont","Bold",True] | Font Bold of Primary Label |
| "Format","Line","PrimaryFont","Italic" | bool | ["Format","Line","PrimaryFont","Italic",True] | Font Italic of Primary Label |
| "Format","Line","PrimaryFont","Underline" | bool | ["Format","Line","PrimaryFont","Underline",True] | Font Underline of Primary Label |
| "Format","Line","PrimaryFont","Alpha" | float | ["Format","Line","PrimaryFont","Alpha",.5] | Font Transparency of Primary Label |
| "Format","Line","SecondaryFont","Size" | float | ["Format","Line","SecondaryFont","Size",25] | Font size of Secondary Label |
| "Format","Line","SecondaryFont","Color" | int - hex color | ["Format","Line","SecondaryFont","Color",0xFF000] | Font Color of Secondary Label |
| "Format","Line","SecondaryFont","Bold" | bool | ["Format","Line","SecondaryFont","Bold",True] | Font Bold of Secondary Label |
| "Format","Line","SecondaryFont","Italic" | bool | ["Format","Line","SecondaryFont","Italic",True] | Font Italic of Secondary Label |
| "Format","Line","SecondaryFont","Underline" | bool | ["Format","Line","SecondaryFont","Underline",True] | Font Underline of Secondary Label |
| "Format","Line","SecondaryFont","Alpha" | float | ["Format","Line","SecondaryFont","Alpha",.5] | Font Transparency of Secondary Label |
X Axis
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Format","Line","AxisX","ShowAxis" | bool | ["Format","Line","AxisX","ShowAxis",True] | Show the x-Axis on the Bar Chart |
| "Format","Line","AxisX","ShowMajorTicks" | bool | ["Format","Line","AxisX","ShowMajorTicks",True] | Show Major Ticks on the x-axis |
| "Format","Line","AxisX","ShowMinorTicks" | bool | ["Format","Line","AxisX","ShowMinorTicks",True] | Show Minor Ticks on the x-axis |
| "Format","Line","AxisX","ShowEndTicks" | bool | ["Format","Line","AxisX","ShowEndTicks",True] | Put Ticks on the end of the x-axis |
| "Format","Line","AxisX","ShowEndLabels" | bool | ["Format","Line","AxisX","ShowEndLabels",True] | Show End Lables on x-axis |
| "Format","Line","AxisX","TickShift" | bool | ["Format","Line","AxisX","TickShift",.7] | Shift Ticks: 0 = center, < 0 = shift out (left or down), > 0 = shift in (right or up) |
| "Format","Line","AxisX","TickSize" | bool | ["Format","Line","AxisX","TickSize",1.7] | Size of Tick in Pixels |
| "Format","Line","AxisX","Line","Color" | int - hex color | ["Format","Line","AxisX","Line","Color",0xFF000] | Line color on the x-axis |
| "Format","Line","AxisX","Line","Size" | float | ["Format","Line","AxisX","Line","Size",2.1] | Line size / thickness on the x-axis |
| "Format","Line","AxisX","Line","Alpha" | float | ["Format","Line","AxisX","Line","Alpha",.5] | Line transparency on the x-axis, between 0-1 |
| "Format","Line","AxisX","ShowLabels" | bool | ["Format","Line","AxisX","ShowLabels",True] | Show Labels on x-axis |
| "Format","Line","AxisX","LabelFont","Size" | float | ["Format","Line","AxisX","LabelFont","Size",25] | Font size on x-axis Labels |
| "Format","Line","AxisX","LabelFont","Color" | int - hex color | ["Format","Line","AxisX","LabelFont","Color",0xFF000] | Font Color on x-axis Labels |
| "Format","Line","AxisX","LabelFont","Bold" | bool | ["Format","Line","AxisX","LabelFont","Bold",True] | Font Bold on x-axis Labels |
| "Format","Line","AxisX","LabelFont","Italic" | bool | ["Format","Line","AxisX","LabelFont","Italic",True] | Font Italic on x-axis Labels |
| "Format","Line","AxisX","LabelFont","Underline" | bool | ["Format","Line","AxisX","LabelFont","Underline",True] | Font Underline on x-axis Labels |
| "Format","Line","AxisX","LabelFont","Alpha" | float | ["Format","Line","AxisX","LabelFont","Alpha",.5] | Font Transparency on x-axis Labels |
| "Format","Line","AxisX","LabelShift" | float | ["Format","Line","AxisX","LabelShift",.5] | Shift Labels Perpedicular To Line: 0 = base, < 0 = shift out (left or down), > 0 = shift in (right or up) |
| "Format","Line","AxisX","LabelFormat" | string | ["Format","Line","AxisX","LabelFormat","#,##0.00"] | Labels Number Format Code (ex: decimal places, commas, dollar sign, etc) |
| "Format","Line","AxisX","LabelAlign" | float | ["Format","Line","AxisX","LabelAlign",.1] | Shift Labels Parallel To Line: 0 = center, < 0 = align bottom (or left), > 0 align top (or right) |
| "Format","Line","AxisX","LabelRotation" | float | ["Format","Line","AxisX","LabelRotation",.5] | Labels Rotation In Radians: 0 = no rotation, 1 = 90 degrees clockwise, -1 = 90 degrees counter-clockwise |
| "Format","Line","AxisX","ShowTitle" | bool | ["Format","Line","AxisX","ShowTitle",True] | Show x-axis Title |
| "Format","Line","AxisX","Title" | string | ["Format","Line","AxisX","Title","Title Text Here"] | Title Text on x-axis |
| "Format","Line","AxisX","TitleFont","Size" | float | ["Format","Line","AxisX","TitleFont","Size",25] | Font size on x-axis Title |
| "Format","Line","AxisX","TitleFont","Color" | int - hex color | ["Format","Line","AxisX","TitleFont","Color",0xFF000] | Font Color on x-axis Title |
| "Format","Line","AxisX","TitleFont","Bold" | bool | ["Format","Line","AxisX","TitleFont","Bold",True] | Font Bold on x-axis Title |
| "Format","Line","AxisX","TitleFont","Italic" | bool | ["Format","Line","AxisX","TitleFont","Italic",True] | Font Italic on x-axis Title |
| "Format","Line","AxisX","TitleFont","Underline" | bool | ["Format","Line","AxisX","TitleFont","Underline",True] | Font Underline on x-axis Title |
| "Format","Line","AxisX","TitleFont","Alpha" | float | ["Format","Line","AxisX","TitleFont","Alpha",.5] | Font Transparency on x-axis Title |
| "Format","Line","AxisX","TitlePos" | [float,float] | ["Format","Line","AxisX","TitlePos",[0.5,0.5]] | X-Axis Title x,y as a percentage of Pane Height/Width |
Y Axis
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Format","Line","AxisY","ShowAxis" | bool | ["Format","Line","AxisY","ShowAxis",True] | Show the y-Axis on the Bar Chart |
| "Format","Line","AxisY","ShowMajorTicks" | bool | ["Format","Line","AxisY","ShowMajorTicks",True] | Show Major Ticks on the y-Axis |
| "Format","Line","AxisY","ShowMinorTicks" | bool | ["Format","Line","AxisY","ShowMinorTicks",True] | Show Minor Ticks on the y-Axis |
| "Format","Line","AxisY","ShowEndTicks" | bool | ["Format","Line","AxisY","ShowEndTicks",True] | Put Ticks on the end of the y-Axis |
| "Format","Line","AxisY","ShowEndLabels" | bool | ["Format","Line","AxisY","ShowEndLabels",True] | Show End Lables on y-Axis |
| "Format","Line","AxisY","TickShift" | bool | ["Format","Line","AxisY","TickShift",.7] | Shift Ticks: 0 = center, < 0 = shift out (left or down), > 0 = shift in (right or up) |
| "Format","Line","AxisY","TickSize" | bool | ["Format","Line","AxisY","TickSize",1.7] | Size of Tick in Pixels |
| "Format","Line","AxisY","Line","Color" | int - hex color | ["Format","Line","AxisY","Line","Color",0xFF000] | Line color on the y-Axis |
| "Format","Line","AxisY","Line","Size" | float | ["Format","Line","AxisY","Line","Size",2.1] | Line size / thickness on the y-Axis |
| "Format","Line","AxisY","Line","Alpha" | float | ["Format","Line","AxisY","Line","Alpha",.5] | Line transparency on the y-Axis, between 0-1 |
| "Format","Line","AxisY","ShowLabels" | bool | ["Format","Line","AxisY","ShowLabels",True] | Show Labels on y-Axis |
| "Format","Line","AxisY","LabelFont","Size" | float | ["Format","Line","AxisY","LabelFont","Size",25] | Font size on y-Axis Labels |
| "Format","Line","AxisY","LabelFont","Color" | int - hex color | ["Format","Line","AxisY","LabelFont","Color",0xFF000] | Font Color on y-Axis Labels |
| "Format","Line","AxisY","LabelFont","Bold" | bool | ["Format","Line","AxisY","LabelFont","Bold",True] | Font Bold on y-Axis Labels |
| "Format","Line","AxisY","LabelFont","Italic" | bool | ["Format","Line","AxisY","LabelFont","Italic",True] | Font Italic on y-Axis Labels |
| "Format","Line","AxisY","LabelFont","Underline" | bool | ["Format","Line","AxisY","LabelFont","Underline",True] | Font Underline on y-Axis Labels |
| "Format","Line","AxisY","LabelFont","Alpha" | float | ["Format","Line","AxisY","LabelFont","Alpha",.5] | Font Transparency on y-Axis Labels |
| "Format","Line","AxisY","LabelShift" | float | ["Format","Line","AxisY","LabelShift",.5] | Shift Labels Perpedicular To Line: 0 = base, < 0 = shift out (left or down), > 0 = shift in (right or up) |
| "Format","Line","AxisY","LabelFormat" | string | ["Format","Line","AxisY","LabelFormat","#,##0"] | Labels Number Format Code (ex: decimal places, commas, dollar sign, etc) |
| "Format","Line","AxisY","LabelAlign" | float | ["Format","Line","AxisY","LabelAlign",.1] | Shift Labels Parallel To Line: 0 = center, < 0 = align bottom (or left), > 0 align top (or right) |
| "Format","Line","AxisY","LabelRotation" | float | ["Format","Line","AxisY","LabelRotation",.5] | Labels Rotation In Radians: 0 = no rotation, 1 = 90 degrees clockwise, -1 = 90 degrees counter-clockwise |
| "Format","Line","AxisY","ShowTitle" | bool | ["Format","Line","AxisY","ShowTitle",True] | Show y-Axis Title |
| "Format","Line","AxisY","Title" | string | ["Format","Line","AxisY","Title","Title Text Here"] | Title Text on y-Axis |
| "Format","Line","AxisY","TitleFont","Size" | float | ["Format","Line","AxisY","TitleFont","Size",25] | Font size on y-Axis Title |
| "Format","Line","AxisY","TitleFont","Color" | int - hex color | ["Format","Line","AxisY","TitleFont","Color",0xFF000] | Font Color on y-Axis Title |
| "Format","Line","AxisY","TitleFont","Bold" | bool | ["Format","Line","AxisY","TitleFont","Bold",True] | Font Bold on y-Axis Title |
| "Format","Line","AxisY","TitleFont","Italic" | bool | ["Format","Line","AxisY","TitleFont","Italic",True] | Font Italic on y-Axis Title |
| "Format","Line","AxisY","TitleFont","Underline" | bool | ["Format","Line","AxisY","TitleFont","Underline",True] | Font Underline on y-Axis Title |
| "Format","Line","AxisY","TitleFont","Alpha" | float | ["Format","Line","AxisY","TitleFont","Alpha",.5] | Font Transparency on y-Axis Title |
| "Format","Line","AxisY","TitlePos" | [float,float] | ["Format","Line","AxisY","TitlePos",[0.5,0.5]] | y-Axis Title x,y as a percentage of Pane Height/Width |
X Grid
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Format","Line","GridlineX","Type" | int | ["Format","Line","GridlineX","Type",1] | X Grid Type: 0=grid_categorical, 1=grid_numeric, 2=grid_datetime |
| "Format","Line","GridlineX","ShowMajor" | bool | ["Format","Line","GridlineX","ShowMajor",True] | Show Major gridlines on X Grid |
| "Format","Line","GridlineX","ShowMinor" | bool | ["Format","Line","GridlineX","ShowMinor",True] | Show Minor gridlines on X Grid |
| "Format","Line","GridlineX","MajorUnit" | float | ["Format","Line","GridlineX","MajorUnit",1.0] | Major Unit on X Grid |
| "Format","Line","GridlineX","MinorUnit" | float | ["Format","Line","GridlineX","MinorUnit",1.0] | Minor Unit on X Grid |
| "Format","Line","GridlineX","AutoMajor" | bool | ["Format","Line","GridlineX","AutoMajor",True] | Automatically Determine Major Unit on X Grid, sets the MajorBase, MajorUnit, and the MajorStart |
| "Format","Line","GridlineX","AutoMinor" | bool | ["Format","Line","GridlineX","AutoMinor",True] | Automatically Determine Minor Unit on X Grid, sets the MinorBase & MinorUnit |
| "Format","Line","GridlineX","MinBound" | float | ["Format","Line","GridlineX","MinBound",10] | Minimum Value For Range Of X Grid (only used if AutoMin Is Off) |
| "Format","Line","GridlineX","MaxBound" | float | ["Format","Line","GridlineX","MaxBound",10] | Maximum Value For Range Of X Grid (only used if AutoMax Is Off) |
| "Format","Line","GridlineX","AutoMin" | bool | ["Format","Line","GridlineX","AutoMin", True] | Automatically Determine MinBound on X Grid |
| "Format","Line","GridlineX","AutoMax" | bool | ["Format","Line","GridlineX","AutoMax", True] | Automatically Determine MaxBound on X Grid |
| "Format","Line","GridlineX","PreferZero" | bool | ["Format","Line","GridlineX","PreferZero", False] | Include 0 in the Range of The X Grid |
| "Format","Line","GridlineX","MajorLine","Color" | int - hex color | ["Format","Line","GridlineX","MajorLine","Color",0xFF000] | Line color on the x-Grid |
| "Format","Line","GridlineX","MajorLine","Size" | float | ["Format","Line","GridlineX","MajorLine","Size",2.1] | Line size / thickness on the x-Grid |
| "Format","Line","GridlineX","MajorLine","Alpha" | float | ["Format","Line","GridlineX","MajorLine","Alpha",.5] | Line transparency on the x-Grid, between 0-1 |
| "Format","Line","GridlineX","GridBase" | int | ["Format","Line","GridlineX","GridBase", 68] | ASCII char value for datetime span divisions: 0 = not set, 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year |
| "Format","Line","GridlineX","MajorBase" | int | ["Format","Line","GridlineX","MajorBase", 68] | ASCII char value for datetime span divisions: 0 = not set, 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year |
| "Format","Line","GridlineX","MinorBase" | int | ["Format","Line","GridlineX","MinorBase", 68] | ASCII char value for datetime span divisions: 0 = not set, 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year |
| "Format","Line","GridlineX","MajorStart" | float | ["Format","Line","GridlineX","MajorStart", 10] | Start Value For The x-Grid |
Y Grid
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Format","Line","GridlineY","Type" | int | ["Format","Line","GridlineY","Type",1] | Y Grid Type: 0=grid_categorical, 1=grid_numeric, 2=grid_datetime |
| "Format","Line","GridlineY","ShowMajor" | bool | ["Format","Line","GridlineY","ShowMajor",True] | Show Major gridlines on Y Grid |
| "Format","Line","GridlineY","ShowMinor" | bool | ["Format","Line","GridlineY","ShowMinor",True] | Show Minor gridlines on Y Grid |
| "Format","Line","GridlineY","MajorUnit" | float | ["Format","Line","GridlineY","MajorUnit",1.0] | Major Unit on Y Grid |
| "Format","Line","GridlineY","MinorUnit" | float | ["Format","Line","GridlineY","MinorUnit",1.0] | Minor Unit on Y Grid |
| "Format","Line","GridlineY","AutoMajor" | bool | ["Format","Line","GridlineY","AutoMajor",True] | Automatically Determine Major Unit on Y Grid, sets the MajorBase, MajorUnit, and the MajorStart |
| "Format","Line","GridlineY","AutoMinor" | bool | ["Format","Line","GridlineY","AutoMinor",True] | Automatically Determine Minor Unit on Y Grid, sets the MinorBase & MinorUnit |
| "Format","Line","GridlineY","MinBound" | float | ["Format","Line","GridlineY","MinBound",10] | Minimum Value For Range Of Y Grid (only used if AutoMin Is Off) |
| "Format","Line","GridlineY","MaxBound" | float | ["Format","Line","GridlineY","MaxBound",10] | Maximum Value For Range Of Y Grid (only used if AutoMax Is Off) |
| "Format","Line","GridlineY","AutoMin" | bool | ["Format","Line","GridlineY","AutoMin", True] | Automatically Determine MinBound on Y Grid |
| "Format","Line","GridlineY","AutoMax" | bool | ["Format","Line","GridlineY","AutoMax", True] | Automatically Determine MaxBound on Y Grid |
| "Format","Line","GridlineY","PreferZero" | bool | ["Format","Line","GridlineY","PreferZero", False] | Include 0 in the Range of The Y Grid |
| "Format","Line","GridlineY","MajorLine","Color" | int - hex color | ["Format","Line","GridlineY","MajorLine","Color",0xFF000] | Line color on the y-Grid |
| "Format","Line","GridlineY","MajorLine","Size" | float | ["Format","Line","GridlineY","MajorLine","Size",2.1] | Line size / thickness on the y-Grid |
| "Format","Line","GridlineY","MajorLine","Alpha" | float | ["Format","Line","GridlineY","MajorLine","Alpha",.5] | Line transparency on the y-Grid, between 0-1 |
| "Format","Line","GridlineY","GridBase" | int | ["Format","Line","GridlineY","GridBase", 68] | ASCII char value for datetime span divisions: 0 = not set, 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year |
| "Format","Line","GridlineY","MajorBase" | int | ["Format","Line","GridlineY","MajorBase", 68] | ASCII char value for datetime span divisions: 0 = not set, 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year |
| "Format","Line","GridlineY","MinorBase" | int | ["Format","Line","GridlineY","MinorBase", 68] | ASCII char value for datetime span divisions: 0 = not set, 68 = 'D' day, 77 = 'M' month, 89 = 'Y' year |
| "Format","Line","GridlineY","MajorStart" | float | ["Format","Line","GridlineY","MajorStart", 10] | Start Value For The y-Grid |
Series Data
(The second value is the series index)
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Series",0,"Name" | string | ["Series",0,"Name","Enter Series Name"] | Name of the series |
| "Series",0,"Labels" | string | ["Series",0,"Labels","=DF1!B:B"] | Lables on the series (list or cell reference like Excel) |
| "Series",0,"XValues" | string | ["Series",0,"XValues","=DF1!A:A"] | X Values of the series (list or cell reference like Excel) |
| "Series",0,"YValues" | string | ["Series",0,"YValues","=DF1!C:C"] | Y Values of the series (list or cell reference like Excel) |
| "Series",0,"ZValues" | string | ["Series",0,"ZValues","=DF1!D:D"] | Z Values of the series (list or cell reference like Excel) |
| "Series",0,"IValues" | string | ["Series",0,"IValues","=DF1!E:E"] | I Values of the series - grid index or row category values |
| "Series",0,"JValues" | string | ["Series",0,"JValues","=DF1!F:F"] | I Values of the series - grid col values |
| "Series",0,"EQOptions","ShowEq" | bool | ["Series",0,"EQOptions","ShowEq",True] | Show Equation |
| "Series",0,"EQOptions","ShowR" | bool | ["Series",0,"EQOptions","ShowR", True] | Show Regression Line |
| "Series",0,"EQOptions","ShowTrendline" | bool | ["Series",0,"EQOptions","ShowTrendline", True] | ShowTrendline |
| "Series",0,"EQOptions","Loc" | [float,float] | ["Series",0,"EQOptions","Loc",[0.25,0.75]] | Equation position x,y as a percentage of Pane Height/Width |
| "Series",0,"EQOptions","RegressionL","Color" | int - hex color | ["Series",0,"EQOptions","RegressionL","Color",0xFF000] | Line color of Regression Line |
| "Series",0,"EQOptions","RegressionL","Size" | float | ["Series",0,"EQOptions","RegressionL","Size",2.1] | Line size / thickness of Regression Line |
| "Series",0,"EQOptions","RegressionL","Alpha" | float | ["Series",0,"EQOptions","RegressionL","Alpha",.5] | Line transparency of Regression Line, between 0-1 |
| "Series",0,"EQOptions","EquationF","Size" | float | ["Series",0,"EQOptions","EquationF","Size",25] | Font size on y-Axis Title |
| "Series",0,"EQOptions","EquationF","Color" | int - hex color | ["Series",0,"EQOptions","EquationF","Color",0xFF000] | Font Color on y-Axis Title |
| "Series",0,"EQOptions","EquationF","Bold" | bool | ["Series",0,"EQOptions","EquationF","Bold",True] | Font Bold on y-Axis Title |
| "Series",0,"EQOptions","EquationF","Italic" | bool | ["Series",0,"EQOptions","EquationF","Italic",True] | Font Italic on y-Axis Title |
| "Series",0,"EQOptions","EquationF","Underline" | bool | ["Series",0,"EQOptions","EquationF","Underline",True] | Font Underline on y-Axis Title |
| "Series",0,"EQOptions","EquationF","Alpha" | float | ["Series",0,"EQOptions","EquationF","Alpha",.5] | Font Transparency on y-Axis Title |
| "Series",0,"ColorMode" | int | ["Series",0,"ColorMode","Enter Series Name"] | Color Fill Style (bar, bubble): 0=solid, 1=simple gradient, 2=four-color gradient, 3=series multi |
| "Series",0,"Colors" | [int,int,int,int] | ["Series",0,"Colors",[0x547B9F,0x547B9F,0x547B9F,0x547B9F]] | Color Theme (bar, bubble) |
| "Series",0,"Marker","Shape" | int | ["Series",0,"Marker","Shape",1] | Marker Shape (scatter, line) placed on Line Points: 0=None, 1=circle, 2=square, 3=triangle |
| "Series",0,"Marker","Size" | float | ["Series",0,"Marker","Size",10.0] | Marker Size (scatter, line) placed on Line Points in pixels |
| "Series",0,"Marker","Alpha" | float | ["Series",0,"Marker","Alpha",.5] | Marker Transparency (scatter, line) |
| "Series",0,"Marker","Color" | int - hex color | ["Series",0,"Marker","Color",0xFF000] | Marker Color (scatter, line) |
| "Series",0,"Marker","HasFill" | bool | ["Series",0,"Marker","HasFill",True] | Marker Is Filled In (scatter, line) |
| "Series",0,"HasLine" | bool | ["Series",0,"HasLine",True] | Line Connecting Scatter Points is Visible (scatter, line) |
| "Series",0,"Line","Color" | int - hex color | ["Series",0,"Line","Color",0xFF000] | Line Color (scatter, line) |
| "Series",0,"Line","Size" | float | ["Series",0,"Line","Size",2.1] | Line Size / thickness (scatter, line) |
| "Series",0,"Line","Alpha" | float | ["Series",0,"Line","Alpha",.5] | Line Transparency (scatter, line) |
| "Series",0,"FillType" | int | ["Series",0,"FillType",True] | Line Fill (scatter, line): 0=None, 1=Solid Fill, 2=Gradient |
| Series,0,"Fill","Color" | int - hex color | ["Series",0,"Fill","Color",0xFF000] | Fill Color Below Line (scatter, line) |
| Series,0,"Fill","Alpha" | float | ["Series",0,"Fill","Alpha",.5] | Fill Transparency Below Line (scatter, line) |
Details
| Parameter Keys | Value Type | Example | Description |
|---|---|---|---|
| "Details","ShowTitle" | bool | ["Details","ShowTitle",True] | Show Chart Title |
| "Details","Title" | string | ["Details","Title","Enter Chart Title"] | String of Chart Title |
| "Details","TitleFont","Size" | float | ["Details","TitleFont","Size",25] | Font size of Title (if ShowTitle is True) |
| "Details","TitleFont","Color" | int - hex color | ["Details","TitleFont","Color",0xFF000] | Font Color of Title (if ShowTitle is True) |
| "Details","TitleFont","Bold" | bool | ["Details","TitleFont","Bold",True] | Font Bold of Title (if ShowTitle is True) |
| "Details","TitleFont","Italic" | bool | ["Details","TitleFont","Italic",True] | Font Italic of Title (if ShowTitle is True) |
| "Details","TitleFont","Underline" | bool | ["Details","TitleFont","Underline",True] | Font Underline of Title (if ShowTitle is True) |
| "Details","TitleFont","Alpha" | float | ["Details","TitleFont","Alpha",.5] | Font Transparency of Title (if ShowTitle is True) |
| "Details","TitlePos" | [float,float] | ["Details","TitlePos",[.5,.05]] | Chart Title x,y as a percentage of Pane Height/Width |
| "Details","Layout","RPadding" | float | ["Details","Layout","RPadding",10.0] | Chart Right Padding Inset In Addition To Pane Padding |
| "Details","Layout","LPadding" | float | ["Details","Layout","LPadding",10.0] | Chart Left Padding Inset In Addition To Pane Padding |
| "Details","Layout","TPadding" | float | ["Details","Layout","TPadding",10.0] | Chart Top Padding Inset In Addition To Pane Padding |
| "Details","Layout","BPadding" | float | ["Details","Layout","BPadding",10.0] | Chart Bottom Padding Inset In Addition To Pane Padding |
| "Details","Layout","HasChartBorder" | bool | ["Details","Layout","HasChartBorder",True] | Chart Border Around Chart Area (Does Not Include Label Area) |
| "Details","Layout","ChartBorder","Color" | int - hex color | ["Details","Layout","ChartBorder","Color",0xFF000] | Line color of Chart Border |
| "Details","Layout","ChartBorder","Size" | float | ["Details","Layout","ChartBorder","Size",2.1] | Line size / thickness of Chart Border |
| "Details","Layout","ChartBorder","Alpha" | float | ["Details","Layout","ChartBorder","Alpha",.5] | Line transparency of Chart Border |
| "Details","Layout","HasChartFill" | bool | ["Details","Layout","HasChartFill",True] | Fill Inner Chart Area (Does Not Include Label Area) |
| "Details","Layout","ChartFill","Color" | int - hex color | ["Details","Layout","ChartFill","Color",0xFF000] | Fill Color Of Inner Chart Area |
| "Details","Layout","ChartFill","Alpha" | float | ["Details","Layout","ChartFill","Alpha",.5] | Transparency Of Inner Chart Area Fill |
| "Details","Layout","HasBkgdFill" | bool | ["Details","Layout","HasBkgdFill",True] | Fill Chart Area (Drawn Overtop Of Any Pane Color) |
| "Details","Layout","BkgdFill","Color" | int - hex color | ["Details","Layout","BkgdFill","Color",0xFF000] | Fill Color Of Chart Area (Drawn Overtop Of Any Pane Color) |
| "Details","Layout","BkgdFill","Alpha" | float | ["Details","Layout","BkgdFill","Alpha",.5] | Transparency Of Chart Area Fill (Drawn Overtop Of Any Pane Color) |