コンテンツへスキップ

pivotick v3.0.0


ピボット / GraphUI / LegendOptions

インターフェース: LegendOptions ​

定義: interfaces/GraphUI.ts:668

UI.legend — キャンバスの凡例。 説明的: 色を報告します レンダラーはすでに解決されており、レンダラーを割り当てないため、コンシューマはそのままになります。 ノードカラーリングの唯一の所有者。

エントリは key (データから抽出され、サンプルからサンプリングされています) レンダラー)、entries (宣言済み)、またはその両方 — key から、 述語を持たないエントリのデフォルトの述語。

どちらも では、凡例はrender.nodeTypeAccessor ( nodeStyleMap に対してすでに宣言した寸法) — ただし、チェックした後でのみ このディメンションが実際にはカラーディメンションであること: すべてのカテゴリを解決する必要があります 正確に 1 つの色を表現するには、少なくとも 2 つの色が必要ですが、その色は十分に少ない必要があります。 それらはカテゴリになります。このチェックが、誰も求めなかった伝説を安全なものにするのです。 UI.legend: true はそれをスキップし、false は凡例を完全に抑制します。

一度に複数の次元でグラフにキーを設定するには、次のように渡します。 代わりにLegendGroupOptions。

full および light モードでのみ表示されます。

例 ​

js
UI: { legend: { key: 'type', title: 'Node type' } }

伸びる ​

プロパティ ​

collapsed? ​

optional collapsed: boolean

定義: interfaces/GraphUI.ts:626

折りたたまれた状態で開始します。

デフォルト ​

ts
false

継承元 ​

LegendSection.collapsed


collapsible? ​

optional collapsible: boolean

定義: interfaces/GraphUI.ts:624

デフォルト ​

ts
true

継承元 ​

LegendSection.collapsible


enabled? ​

optional enabled: boolean

定義: interfaces/GraphUI.ts:586

デフォルト ​

ts
true when the block is present

継承元 ​

LegendSection.enabled


entries? ​

optional entries: LegendEntry[] | (graph) => LegendEntry[]

定義: interfaces/GraphUI.ts:622

宣言されたエントリ、またはライブ グラフに対して再解決される関数は、 凡例が再構築される時間を指定します (リストがデータに従うことができるようになります)。

継承元 ​

LegendSection.entries


filterable? ​

optional filterable: boolean

定義: interfaces/GraphUI.ts:630

エントリをクリックすると、グラフがフィルタリングされます。 false は純粋なキーをレンダリングします。

デフォルト ​

ts
true

継承元 ​

LegendSection.filterable


highlightOnHover? ​

optional highlightOnHover: boolean

定義: interfaces/GraphUI.ts:637

エントリにマウスを置くと、そのカテゴリがキャンバスから読み取られます。つまり、それが表す要素が表示されます。 見た目を維持し、ポインタが離れるまで他のすべてが暗くなります。で動作します filterable: false キーも同様です。カテゴリをポイントしてもグラフは何も表示されません。

デフォルト ​

ts
true

継承元 ​

LegendSection.highlightOnHover


id? ​

optional id: string

定義: interfaces/GraphUI.ts:605

安定したアイデンティティ: セクション独自のフィルター キー (__legend:<id>) と legendToggle イベントの section フィールド。

デフォルト ​

key、それ以外の場合は section-<index>

継承元 ​

LegendSection.id


key? ​

optional key: string

定義: interfaces/GraphUI.ts:617

派生モード: それぞれの個別の値がエントリとなるデータ キー レンダラーの解決されたスタイルからサンプリングされたスウォッチ。オフノードまたはオフエッジを読み取る スコープが'edge'の場合。また、次の場合にデフォルトの述語も提供します。 entries は 1 なしで宣言されます。

継承元 ​

LegendSection.key


maxVisibleEntries? ​

optional maxVisibleEntries: number

定義: interfaces/GraphUI.ts:639

リストがスクロールする前にエントリが表示されます。

デフォルト ​

ts
12

継承元 ​

LegendSection.maxVisibleEntries


position? ​

optional position: LegendPosition

定義: interfaces/GraphUI.ts:675

どのコーナーにドッキングするか。 full モードでは、デフォルトは右の列です。 ミニマップの上に積み重ねられています - 左側のマップはモード レールに属しており、その パネル。他のモードでは左下隅が維持されます。

デフォルト ​

full モードでは「右下」、それ以外の場合は 'bottom-left'


scope? ​

optional scope: LegendScope

定義: interfaces/GraphUI.ts:599

このセクションはどのコレクションに焦点を当てていますか。 'edge' はグラフの関係をリストします。 line スウォッチを持つ種類 - レンダラーとしてのストローク カラー、ダッシュ、マーカー それらは解決されました — そしてそのトグルはエッジを非表示にします レイヤー: ノードはそのままです。 レイアウト、選択、カメラを行います。

edge セクションは、UI.filter.edgeFacets が宣言しているかどうかをフィルターします。 キー: 1 つ指定すると、そのファセットが駆動されるため、パネルと凡例が 2 つのビューになります。 1 つのフィルター。何もなければ、それは独自の側面を保持します。

デフォルト ​

ts
'node'

継承元 ​

LegendSection.scope


showCounts? ​

optional showCounts: boolean

定義: interfaces/GraphUI.ts:628

エントリごとの要素数を表示します。

デフォルト ​

ts
true

継承元 ​

LegendSection.showCounts


title? ​

optional title: string

定義: interfaces/GraphUI.ts:610

ヘッダー テキスト。そのまま使用されます (翻訳可能です)。

デフォルト ​

きれいなkey、そうでない場合は'Legend'

継承元 ​

LegendSection.title