Skip to content

Scripting.md

Latest commit

 

History

History
85 lines (58 loc) · 3.68 KB

Scripting.md

File metadata and controls

85 lines (58 loc) · 3.68 KB
Raw

スクリプト API

LowCode のスクリプトから ApexChartField (3種のフィールド共通の実装クラス) を操作するための API 一覧です。

← README に戻る

目次

リロード / 追加検索条件

Reload()

SearchCondition + 追加検索条件 (後述) を使って再取得し、チャートを再描画します。

ApexChart1.Reload();

AllowLoad = false のときは何もしません。

SetAdditionalCondition(searcher)

別画面の ModuleSearcher から取得した検索条件を、現在のチャートの SearchCondition にマージします。 ModuleName が一致しない場合は例外がスローされます ("{ModuleName} Invalid Module")。

ApexChart1.SetAdditionalCondition(Searcher1);

外部フィールド (OnExternalFieldChanged) と連動して、参照中のフィールドが変わったときに自動でリロードもされます。

アノテーション

X軸 / Y軸の基準線をスクリプトから追加・削除できます。 内部的に ApexCharts の Annotations.Xaxis / Annotations.Yaxis に変換されます。

ChartAnnotation クラス

プロパティ 型 既定値 説明
Axis AnnotationAxis (X / Y) X 配置軸。AnnotationAxis.X で縦線、AnnotationAxis.Y で横線。
Value object 0 基準線の位置。数値または CategoryField と整合する値を渡します。
Color string "#00E396" 線の色 (#RRGGBB)。ラベル背景にも使用されます。
Label string? null ラベル文字列。指定した場合のみラベル表示。文字色は背景色のコントラストから自動 (黒/白) で決定。
IsDashed bool false true で破線。false で実線。

AddAnnotation(name, ChartAnnotation)

名前付きでアノテーションを追加します。同じ名前で追加すると上書きされます。

var a = new ChartAnnotation();
a.Axis = AnnotationAxis.X;
a.Value = 300;
a.Color = "#ff0000";
a.Label = "threshold";
a.IsDashed = true;
ApexChart5.AddAnnotation("threshold", a);

RemoveAnnotation(name) / ClearAnnotation()

ApexChart5.RemoveAnnotation("threshold");
ApexChart5.ClearAnnotation();

スクリプトから扱えるプロパティ

プロパティ 型 説明
AllowLoad bool false の場合 Reload() を呼んでもデータ取得しません。初期表示を抑制したい場合に使用します。
Options ApexChartOptions<SeriesData> Blazor-ApexCharts のオプションオブジェクト。詳細な見た目調整に直接アクセスできます。

※ Options を直接書き換える場合、初期化処理 (Reload() / 系列変更等) で一部の値が上書きされる場合があります。 詳細は Codeer.LowCode.Bindings.ApexCharts/Fields/ApexChartField.cs の InitilaizeCore を参照してください。

注意

  • スクリプトから AnnotationAxis / ChartAnnotation を使用するには、ApexChartsClientInitializer.Initialize(this) (Client.Shared) と ApexChartsDesignerInitializer.Initialize(BlazorRuntime) (Designer) で型登録が行われている必要があります。
  • イベントハンドラ系のプロパティ (OnQueryChangedAsync / OnSearchDataChangedAsync) は [ScriptHide] でスクリプト公開対象外です。