# インターフェース: LegendElement<TType>
# 型パラメータ
| 名前 | 型 |
|---|---|
TType | extends ChartType |
# 階層
default<AnyObject,LegendOptions<TType>>-
↳
LegendElement
# プロパティ
# $animations
• $animations: Record<string, Animation>
# 継承元
Element.$animations
# 定義元
core/core.element.ts:15 (新しいウィンドウで開きます)
# active
• active: boolean = false
# 継承元
Element.active
# 定義元
core/core.element.ts:13 (新しいウィンドウで開きます)
# bottom
• bottom: number
アイテムの下端。レイアウトシステムによって設定され、更新で使用することはできません
# 継承元
# 定義元
types/layout.d.ts:41 (新しいウィンドウで開きます)
# chart
• chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>
# 定義元
types/index.d.ts:2343 (新しいウィンドウで開きます)
# ctx
• ctx: CanvasRenderingContext2D
# 定義元
types/index.d.ts:2344 (新しいウィンドウで開きます)
# fullSize
• fullSize: boolean
trueの場合、およびアイテムが水平の場合、垂直ボックスを下にプッシュします
# 継承元
# 定義元
types/layout.d.ts:17 (新しいウィンドウで開きます)
# height
• height: number
アイテムの高さ。 update() の後で有効である必要があります
# 継承元
# 定義元
types/layout.d.ts:25 (新しいウィンドウで開きます)
# left
• left: number
アイテムの左端。レイアウトシステムによって設定され、更新で使用することはできません
# 継承元
# 定義元
types/layout.d.ts:29 (新しいウィンドウで開きます)
# legendItems
• Optional legendItems: LegendItem[]
# 定義元
types/index.d.ts:2345 (新しいウィンドウで開く)
# options
• options: LegendOptions<TType>
# Overrides
Element.options
# Defined in
types/index.d.ts:2346 (新しいウィンドウで開く)
# position
• position: LayoutPosition
チャートレイアウトにおけるアイテムの位置。取りうる値は以下の通りです。
# Inherited from
# Defined in
types/layout.d.ts:9 (新しいウィンドウで開く)
# right
• right: number
アイテムの右端。レイアウトシステムによって設定され、更新には使用できません。
# Inherited from
# Defined in
types/layout.d.ts:37 (新しいウィンドウで開く)
# top
• top: number
アイテムの上端。レイアウトシステムによって設定され、更新には使用できません。
# Inherited from
# Defined in
types/layout.d.ts:33 (新しいウィンドウで開く)
# weight
• weight: number
アイテムをソートするために使用される重み。重みが大きいほど、チャート領域から遠くなります。
# Inherited from
# Defined in
types/layout.d.ts:13 (新しいウィンドウで開く)
# width
• width: number
アイテムの幅。update() の後で有効である必要があります。
# Inherited from
# Defined in
types/layout.d.ts:21 (新しいウィンドウで開く)
# x
• x: number
# Inherited from
Element.x
# Defined in
core/core.element.ts:11 (新しいウィンドウで開く)
# y
• y: number
# Inherited from
Element.y
# Defined in
core/core.element.ts:12 (新しいウィンドウで開く)
# Methods
# beforeLayout
▸ Optional beforeLayout(): void
レイアウト処理が開始される前に呼び出されます。
# Returns
void
# Inherited from
# Defined in
types/layout.d.ts:46 (新しいウィンドウで開く)
# draw
▸ draw(chartArea): void
要素を描画します
# Parameters
| 名前 | 型 |
|---|---|
chartArea | ChartArea |
# Returns
void
# Inherited from
# Defined in
types/layout.d.ts:50 (新しいウィンドウで開く)
# getPadding
▸ Optional getPadding(): ChartArea
端のパディングを持つオブジェクトを返します
# Returns
# Inherited from
# Defined in
types/layout.d.ts:54 (新しいウィンドウで開く)
# getProps
▸ getProps<P>(props, final?): Pick<AnyObject, P[number]>
各プロパティの現在または最終的な値を取得します。追加のプロパティ（オブジェクト全体）を返すことができます。
# Type parameters
| 名前 | 型 |
|---|---|
P | extends string[] |
# Parameters
| 名前 | 型 | Description |
|---|---|---|
props | P | 取得するプロパティ |
final? | boolean | 最終値（アニメーションターゲット）を取得します |
# Returns
Pick<AnyObject, P[number]>
# Inherited from
Element.getProps
# Defined in
core/core.element.ts:31 (新しいウィンドウで開く)
▸ getProps<P>(props, final?): Partial<Record<P, unknown>>
# Type parameters
| 名前 | 型 |
|---|---|
P | extends string |
# Parameters
| 名前 | 型 |
|---|---|
props | P[] |
final? | boolean |
# Returns
Partial<Record<P, unknown>>
# Inherited from
Element.getProps
# Defined in
core/core.element.ts:32 (新しいウィンドウで開く)
# hasValue
▸ hasValue(): boolean
# Returns
boolean
# Inherited from
Element.hasValue
# Defined in
core/core.element.ts:22 (新しいウィンドウで開く)
# isHorizontal
▸ isHorizontal(): boolean
レイアウトアイテムが水平（つまり、上または下）の場合にtrueを返します。
# Returns
boolean
# Inherited from
# Defined in
types/layout.d.ts:58 (新しいウィンドウで開く)
# tooltipPosition
▸ tooltipPosition(useFinalPosition): Point
# パラメータ
| 名前 | 型 |
|---|---|
useFinalPosition | boolean |
# 戻り値
# 継承元
Element.tooltipPosition
# 定義場所
core/core.element.ts:17 (新しいウィンドウで開く)
# update
▸ update(width, height, margins?): void
幅と高さの2つのパラメータを受け取ります。
# パラメータ
| 名前 | 型 |
|---|---|
width | number |
height | number |
margins? | ChartArea |
# 戻り値
void
# 継承元
# 定義場所
← LayoutItem LegendItem →