文档属性参考

以下是所创建的数据表文档的属性：

data [any] 表中包含的数据

vlegend [any] 垂直图例中包含的数据

hlegend [any] 水平图例中包含的数据

dformat (int) 表中数据的数字格式，通过组合数字格式常量指定

vformat (int) 表格垂直图例的数字格式，通过组合数字格式常量指定

hformat (int) 表格水平图例的数字格式，通过组合数字格式常量指定

cellwidth (real) 表格中每个单元格的宽度，以字符数指定（使用指定字体的平均字符宽度）

legendwidth (real) 垂直图例的宽度，以字符数指定（使用指定字体的平均字符宽度）

示例：

var x=insertdatasheet("Stock Prices");
document[x].data=[[34.5,33.6,35.1],[80.1,85.2,85.9]];
document[x].vlegend=[2004,2005,2006];
document[x].hlegend=["Stock 1","Stock 2"];
document[x].dformat=FMT_D2+FMT_FIX+FMT_DLR;
document[x].vformat=FMT_D0;
document[x].hformat=0;
document[x].cellwidth=30;
document[x].legendwidth=20;

图表属性¶

目前没有可通过编程方式修改的图表（Diagram）文档属性。不过，仍可通过 insertdiagramsheet 创建新的图表文档

图形属性¶

以下是图形（Graph）文档的属性，由 insertgraphsheet 创建

data (exe)->[real] 图形中包含的 Y 数据点，以可求值文本表示（例如节点名称）。最多可包含 4 组数据点

x (exe)->[real] X 数据点，以可求值文本表示（例如节点名称）

style1 (int) 第一组数据的样式。通过组合图形样式常量指定。包含图形的全局图形样式以及第一组数据的单条迹线样式。

style2 (int) 第二组数据的样式。通过组合图形样式常量指定。包含第二组数据的单条迹线样式。请注意，任何全局图形样式都会被忽略。

style3 (int) 第三组数据的样式。通过组合图形样式常量指定。包含第三组数据的单条迹线样式。请注意，任何全局图形样式都会被忽略。

style4 (int) 第四组数据的样式。通过组合图形样式常量指定。包含第四组数据的单条迹线样式。请注意，任何全局图形样式都会被忽略。

title (text) 图形的标题

xlabel (text) x 轴的标签

ylabel (text) y 轴的标签

legend (exe)->[text] 每组 y 数据的标签，以可执行文本表示（例如节点名称）

analysis (int) 分析类型。这是一个整数，表示在图形属性（Graph Properties）的“分析”（Analysis）选项卡上“数据筛选器”（Data Filter）列表框中选定的值

param1 (real) 由 analysis 属性指定的分析的第一参数值

param2 (real) 由 analysis 属性指定的分析的第二参数值

param3 (real) 由 analysis 属性指定的分析的第三参数值

param4 (real) 由 analysis 属性指定的分析的第四参数值

formula (bool) 为 True 时在图形上显示公式，为 False 时不显示公式

extent (real) 图形趋势延伸到的值。仅当 useextent 为 True 时使用此值

useextent (bool) 为 True 时延伸图形趋势（至 extent 中指定的值），为 False 时不延伸趋势

yformat (int) y 轴数据的数字格式，通过组合数字格式常量指定

xformat (int) x 轴数据的数字格式，通过组合数字格式常量指定

x1 (real) X 轴下限，仅当使用 GS_LIMITX1 图形样式时使用

x2 (real) X 轴上限，仅当使用 GS_LIMITX2 图形样式时使用

y1 (real) Y 轴下限，仅当使用 GS_LIMITY1 图形样式时使用

y2 (real) Y 轴上限，仅当使用 GS_LIMITY2 图形样式时使用

示例：

var x=insertgraph("Product Sales");
document[x].data="Sales";
document[x].x="Months";
document[x].style1=GS_BAR+GS_AXES+GS_COLOR+GS_LIMITY1;
document[x].style2=GS_BAR;
document[x].title="Sales";
document[x].xlabel="Year";
document[x].ylabel="Millions";
document[x].legend="['ABC','XYZ']";
document[x].yformat=FMT_D0+FMT_DLR;
document[x].y1=0;
Sales:=[[3,7,12,15],[9,10,10,12]];
Months:=[1,2,3,4];

注意：上面的示例代码只有在使用圆括号而非花括号时才能正常工作，这样它才会在模型命名空间中执行。

曲面图属性¶

以下是曲面图（Surface Plot）文档的属性，由以下方式创建：insertgraphsheet

以下是曲面图（Surface Plot）文档的属性，由以下方式创建：

data (exe)->[real] Z 轴值，以可执行文本表示（例如节点名称）

x (exe)->[real] X 轴值，以可执行文本表示（例如节点名称）

y (exe)->[real] Y 轴值，以可执行文本表示（例如节点名称）

style (int) 图形样式，通过组合图形样式常量指定

title (text) 图形的标题

xlabel (text) X 轴标签

ylabel (text) Y 轴标签

zlabel (text) Z 轴标签

contours (int) 要在图形上绘制的等高线数量。将此值设为 0 将使图形自动选择合理的等高线数量

xformat (int) x 轴标签的数字格式，通过组合数字格式常量指定

yformat (int) y 轴标签的数字格式，通过组合数字格式常量指定

dformat (int) z 轴标签的数字格式，通过组合数字格式常量指定

示例：

var x=insertgraph3("Sales Grid");
document[x].data="SalesData";
document[x].x="SalesX";
document[x].y="SalesY";
document[x].style=G3_DEFSTYLE;
document[x].title="Title";
document[x].xlabel="x";
document[x].ylabel="y";
document[x].zlabel="Millions";
document[x].dformat=FMT_D0+FMT_DLR;
SalesData:=[[10,18,20],[30,52,40],[25,30,25]];
SalesX:=[1,2];
SalesY:=[1,2];

注意：上面的示例代码只有在使用圆括号而非花括号时才能正常工作，这样它才会在模型命名空间中执行。

报表属性¶

以下是报表（Report）文档的属性，由以下方式创建：

text (text) 工作表的文本

rtf (text) 工作表的 RTF（富文本格式）版本（可包含文本格式）

html (text) 工作表的 HTML 版本。此属性为只读。

editmode (bool) 为 TRUE 时使报表可编辑，为 FALSE 时显示计算值（只读）

示例：

var x=insertreportsheet("Sales Report");
document[x].text="\
  Sales Report
  Sales (in millions) were: <%Sales%>";

演示表格属性¶

以下是演示表格（Presentation Table）文档的属性，由以下方式创建：

data (exe)->[real] 要显示的数据，以可执行文本表示（例如节点名称）

vlegend (exe)->[real] 垂直图例的值，以可执行文本表示（例如节点名称）

hlegend (exe)->[real] 水平图例的值，以可执行文本表示（例如节点名称）

style (int) 表格样式，通过组合表格样式常量指定

title (text) 表格的标题

vlabel (text) 表格的垂直标签

hlabel (text) 表格的水平标签

tbmargin (real) 每个单元格内的上下边距，以字符高度为单位

lrmargin (real) 每个单元格内的左右边距，以平均字符宽度为单位

dformat (int) 表格数据的数字格式，通过组合数字格式常量指定

vformat (int) 垂直图例的数字格式，通过组合数字格式常量指定

hformat (int) 水平图例的数字格式，通过组合数字格式常量指定

示例：

var x=inserttable("My Table");
document[x].data="Sales Data";
document[x].hlegend="Sales Products";
document[x].style=TS_DEFSTYLE;
document[x].title="Product Sales";
document[x].vlabel="Year";
document[x].hlabel="Product";
document[x].dformat=FMT_D0+FMT_DLR;
Sales Data:=[[3,7,12,15],[9,10,10,12]];
Sales Products:=["ABC","XYZ"];

注意：上面的示例代码只有在使用圆括号而非花括号时才能正常工作，这样它才会在模型命名空间中执行。

文本工作表属性¶

以下是文本工作表（Text Sheet）文档的属性，由以下方式创建：

text (text) 工作表的文本

rtf (text) 工作表的 RTF（富文本格式）版本（可包含文本格式）

html (text) 工作表的 HTML 版本。此属性为只读。

示例：

var x=inserttextsheet("Instructions");
document[x].text="This is a model for forecasting sales for the next few quarters";

树工作表属性¶

以下是树工作表（Tree Sheet）文档的属性，由以下方式创建：

rootnode (text) 工作表根节点的名称

pageroot (text) 工作表分页节点的名称（如果用户分页进入某个分支，则与 rootnode 不同）

changenodetype (method) 在决策树分析中，调用此属性可在决策节点和事件节点之间切换所选节点。

style (int) 树样式，通过组合树样式常量指定

title (text) 树工作表的标题

示例：

var x=inserttreesheet("ROE Model");
document[x].rootnode="ROE";
ROE:=Profit/Equity;
Profit:=PBT-Tax;
PBT:=100000;
Tax:=PBT*34%;
Equity:=Assets-Liabilities;
Assets:=700000;
Liabilities:=250000;

注意：上面的示例代码只有在使用圆括号而非花括号时才能正常工作，这样它才会在模型命名空间中执行。

节点属性¶

以下是节点的属性：

note (text) 节点的注释

form (text) 节点的对话框窗体，如果没有窗体则为 null

nodeformat (int) 指定节点的格式，包括最大节点长度。此属性通过组合节点格式常量指定，并可选择添加最大节点长度值（1-255）。

valueformat (int) 节点的数字格式，通过组合数字格式常量指定

color (int) 节点的颜色（RGB 十六进制格式）。RGB 函数可帮助将 RGB 强度值转换为十六进制格式。

showformat (int) 节点的显示格式，通过组合节点显示格式常量指定

group (int) 如果非零，定义包含此节点的组的 ID

groupchild (int) 如果非零，则这是一个组节点，此值定义此组中节点在其 group 属性中将具有的 ID。

value (any) 节点的值

reductionunit (bool) 如果节点定义了缩减单元，则为 True

execnamespace (int) 执行命名空间的名称（此节点将在其中执行）

homenamespace (int) 主命名空间的名称（此节点在其中定义）

minargs (text) 节点接受的最小参数数量（函数名本身加 1）。此属性为只读。

maxargs (text) 节点接受的最大参数数量（函数名本身加 1）。此属性为只读。

definition (text) 节点的系统定义。此属性为只读。

示例：

each(document[x].valueformat=FMT_SEP+FMT_DLR,x,
user(treelist("ROE")));
document.ROE.valueformat=FMT_PCT;
document.ROE.color=RGB(0,0,255);
document.ROE.note="Return on Equity";

注意：此示例基于树工作表文档（ROE）示例中创建的工作表/节点。建议在运行此示例之前先运行该示例以创建 ROE 工作表。