# インターフェース: LegendOptions<TType>

# 型パラメータ

名前
TType extends ChartType

# プロパティ

# align

align: Align

凡例の配置。

デフォルト

'center'

# 定義済み

types/index.d.ts:2364 (新しいウィンドウで開きます)


# display

display: boolean

凡例を表示しますか?

デフォルト

true

# 定義済み

types/index.d.ts:2354 (新しいウィンドウで開きます)


# fullSize

fullSize: boolean

このボックスがキャンバスの全幅/全高を取るようにマークします(他のボックスを移動します)。これは、日常的な使用では変更する必要がない可能性が高いです。

デフォルト

true

# 定義済み

types/index.d.ts:2377 (新しいウィンドウで開きます)


# labels

labels: Object

# 型宣言

名前 説明
borderRadius number 使用するborderRadiusをオーバーライドします。**`デフォルト`** undefined
boxHeight number 色のついたボックスの高さ。**`デフォルト`** fontSize
boxPadding number 色のついたボックスとテキストの間のパディング **`デフォルト`** 1
boxWidth number 色のついたボックスの幅。**`デフォルト`** 40
color ラベルの色 **`参照`** Defaults.color
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext> ラベルのフォント **`参照`** Defaults.font
padding number 色のついたボックスの行間の゚ディング。**`デフォルト`** 10
pointStyle PointStyle 凡例の点のスタイルをオーバーライドします。usePointStyleがtrueの場合にのみ適用されます。
pointStyleWidth number usePointStyleがtrueの場合、凡例に使用される点のスタイルの幅。
textAlign? TextAlign テキストの配置
useBorderRadius boolean ラベルのborderRadiusは対応するborderRadiusと一致します。**`デフォルト`** false
usePointStyle boolean ラベルスタイルは対応する点のスタイルと一致します(サイズはboxWidthとfont.sizeの最小値に基づきます)。**`デフォルト`** false
filter (item: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => boolean 凡例項目を凡例からフィルタリングします。2つのパラメータ、Legend Itemとチャートデータを受け取ります。
generateLabels (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => LegendItem[] 凡例内の各項目に対して凡例項目を生成します。デフォルトの実装は、色のついたボックスのテキストとスタイルを返します。詳細はLegend Itemを参照してください。
sort (a: LegendItem, b: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => number 凡例項目をソートします。

# 定義済み

types/index.d.ts:2396 (新しいウィンドウで開きます)


# maxHeight

maxHeight: number

凡例の最大高さ(ピクセル単位)。

# 定義済み

types/index.d.ts:2368 (新しいウィンドウで開きます)


# maxWidth

maxWidth: number

凡例の最大幅(ピクセル単位)。

# 定義済み

types/index.d.ts:2372 (新しいウィンドウで開きます)


# position

position: LayoutPosition

凡例の配置。

デフォルト

'top'

# 定義済み

types/index.d.ts:2359 (新しいウィンドウで開きます)


# reverse

reverse: boolean

凡例は、データセットを逆順に表示します。

デフォルト

false

# 定義されている場所

types/index.d.ts:2382 (新しいウィンドウで開きます)


# rtl

rtl: boolean

右から左に凡例を描画する場合にtrue。

# 定義されている場所

types/index.d.ts:2477 (新しいウィンドウで開きます)


# textDirection

textDirection: string

キャンバスに指定されたCSSに関係なく、凡例を描画するためのテキスト方向「rtl」または「ltr」を強制します。

デフォルト

キャンバスのデフォルト

# 定義されている場所

types/index.d.ts:2482 (新しいウィンドウで開きます)


# title

title: Object

# 型宣言

名前 説明
color タイトルの色 **参照** Defaults.color
display boolean 凡例タイトルが表示されるかどうか。**デフォルト** false
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext> フォントを参照
padding? number | ChartArea -
position "center" | "end" | "start" -
text string タイトル文字列。

# 定義されている場所

types/index.d.ts:2484 (新しいウィンドウで開きます)

# メソッド

# onClick

onClick(this, e, legendItem, legend): void

ラベル項目でクリックイベントが登録されたときに呼び出されるコールバック。

# パラメータ

名前
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# 戻り値

void

# 定義されている場所

types/index.d.ts:2386 (新しいウィンドウで開きます)


# onHover

onHover(this, e, legendItem, legend): void

ラベル項目の上に「mousemove」イベントが登録されたときに呼び出されるコールバック。

# パラメータ

名前
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# 戻り値

void

# 定義されている場所

types/index.d.ts:2390 (新しいウィンドウで開きます)


# onLeave

onLeave(this, e, legendItem, legend): void

以前にホバーしていたラベル項目の外側に「mousemove」イベントが登録されたときに呼び出されるコールバック。

# パラメータ

名前
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# 戻り値

void

# 定義されている場所

types/index.d.ts:2394 (新しいウィンドウで開きます)