跳到主要內容

ChartsReferenceLineAPI

React ChartsReferenceLine 組件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。

示範

匯入

import { ChartsReferenceLine } from '@mui/x-charts/ChartsReferenceLine';
// or
import { ChartsReferenceLine } from '@mui/x-charts';
// or
import { ChartsReferenceLine } from '@mui/x-charts-pro';

透過閱讀關於最小化 bundle size 的指南,瞭解它們之間的差異。

Props

名稱類型預設值描述
axisIdnumber
| string
第一個定義的座標軸的 `id`。

用於參考值的座標軸 id。

classesobject-

覆寫或擴展應用於組件的樣式。

請參閱下方CSS 類別 API 以取得更多詳細資訊。

labelstring-

沿著參考線顯示的標籤。

labelAlign'end'
| 'middle'
| 'start'
'middle'

如果標籤位於圖表繪圖區域中,則為對齊方式。

labelStyleobject-

應用於標籤的樣式。

lineStyleobject-

應用於線條的樣式。

spacingnumber
| { x?: number, y?: number }
5

標籤周圍的額外空間,以 px 為單位。可以是數字或物件 { x, y },以區分與參考線的間距以及與座標軸的間距。

xDate
| number
| string
-

與參考線關聯的 x 值。如果已定義,則參考線將為垂直線。

yDate
| number
| string
-

與參考線關聯的 y 值。如果已定義,則參考線將為水平線。

組件無法持有 ref。

CSS 類別

這些類別名稱對於使用 CSS 設定樣式很有用。它們在觸發特定狀態時應用於組件的插槽。

類別名稱規則名稱描述
.MuiChartsReferenceLine-horizontalhorizontal如果參考線為水平線,則應用於根元素。
.MuiChartsReferenceLine-labellabel應用於參考標籤的樣式。
.MuiChartsReferenceLine-lineline應用於參考線的樣式。
.MuiChartsReferenceLine-rootroot應用於根元素的樣式。
.MuiChartsReferenceLine-verticalvertical如果參考線為垂直線,則應用於根元素。

您可以使用以下其中一種自訂選項覆寫組件的樣式

原始碼

如果您在此頁面中找不到資訊,請考慮查看組件的實作以取得更多詳細資訊。