Excel.ChartTrendline class
このオブジェクトは、グラフの近似曲線オブジェクトの属性を表します。
- Extends
注釈
プロパティ
| backward |
近似曲線を後方へ拡張するときの区間数を表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| format | グラフの近似曲線の書式設定を表します。 |
| forward |
近似曲線を前方へ拡張するときの区間数を表します。 |
| intercept | 近似曲線の切片の値を表します。 数値または空の文字列を設定できます (値を自動的に設定する場合)。 戻り値は常に数値です。 |
| label | グラフの近似曲線のラベルを表します。 |
| moving |
グラフの近似曲線の期間を表します。 型が |
| name | 近似曲線の名前を表します。 文字列値に設定でき、 |
| polynomial |
グラフの近似曲線の順序を表します。 型が |
| show |
true の場合、グラフに近似曲線の数式が表示されます。 |
| show |
True の場合、近似曲線の r 二乗値がグラフに表示されます。 |
| type | グラフの近似曲線の種類を表します。 |
メソッド
| delete() | trendline オブジェクトを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
backwardPeriod
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
format
グラフの近似曲線の書式設定を表します。
readonly format: Excel.ChartTrendlineFormat;プロパティ値
注釈
forwardPeriod
intercept
近似曲線の切片の値を表します。 数値または空の文字列を設定できます (値を自動的に設定する場合)。 戻り値は常に数値です。
intercept: any;プロパティ値
any
注釈
label
グラフの近似曲線のラベルを表します。
readonly label: Excel.ChartTrendlineLabel;プロパティ値
注釈
movingAveragePeriod
グラフの近似曲線の期間を表します。 型が MovingAverageの近似曲線にのみ適用されます。
movingAveragePeriod: number;プロパティ値
number
注釈
name
近似曲線の名前を表します。 文字列値に設定でき、 null 値は自動値を表します。 戻り値は常に文字列です。
name: string;プロパティ値
string
注釈
polynomialOrder
グラフの近似曲線の順序を表します。 型が Polynomialの近似曲線にのみ適用されます。
polynomialOrder: number;プロパティ値
number
注釈
showEquation
showRSquared
type
グラフの近似曲線の種類を表します。
type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";プロパティ値
Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
let seriesCollection = sheet.charts.getItemAt(0).series;
// Get the trendline for series 1 and load its type property.
let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
trendline.load("type");
await context.sync();
console.log("The trendline type is:" + trendline.type);
});
メソッドの詳細
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ChartTrendline;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTrendline;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ChartTrendlineUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ChartTrendline): void;パラメーター
- properties
- Excel.ChartTrendline
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartTrendline オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartTrendlineData として型指定) を返します。
toJSON(): Excel.Interfaces.ChartTrendlineData;戻り値
Office Add-ins