請求 · d3.js API中文手冊

# 請求 > [Wiki](Home) ? \[\[API--中文手冊\]\] ? \[\[核心函數\]\] ? **請求** - 本文檔是D3官方文檔中文翻譯，并保持與[最新版](https://github.com/mbostock/d3/wiki/API-Reference)同步。 - 如發現翻譯不當或有其他問題可以通過以下方式聯系譯者: - 郵箱：zhang\_tianxu@sina.com - QQ群：[D3數據可視化](http://jq.qq.com/?_wv=1027&k=ZGcqYF)205076374，[大數據可視化](http://jq.qq.com/?_wv=1027&k=S8wGMe)436442115 如果你不訪問數據那么你就不能可視化它。幸運的是有很多的方法可以把數據放到瀏覽器中。對于小數據集，你可以硬編碼到你的腳本里，或者使用數據屬性嵌入到DOM中。對于大數據集，你可以引用外部腳本并定義你的數據為一個全局變量。（JSONP就是一個常見的例子）。最通用的方式是使用XMLHttpRequest, 或說XHR加載數據到瀏覽器。這允許一步加載數據（當數據加載之后其他的頁面就可以展示了），并且比JSONP更安全。D3的xhr模塊可以簡單的加載和解析數據。當異步加載數據時，代碼取決于加載的數據通常存在于回調函數之內。例如D3網站的案例calendar visualization ：[http://mbostock.github.com/d3/ex/calendar.html代碼不依賴于數據可以在頁面加載時立即運行。你也可以發現保存數據到全局命名空間是很方便的，這樣你就可以在初始化渲染之后訪問它，例如在過渡期間。你可以使用閉包實現它，或者簡單地指定加載數據為全局變量。](http://mbostock.github.com/d3/ex/calendar.html%E4%BB%A3%E7%A0%81%E4%B8%8D%E4%BE%9D%E8%B5%96%E4%BA%8E%E6%95%B0%E6%8D%AE%E5%8F%AF%E4%BB%A5%E5%9C%A8%E9%A1%B5%E9%9D%A2%E5%8A%A0%E8%BD%BD%E6%97%B6%E7%AB%8B%E5%8D%B3%E8%BF%90%E8%A1%8C%E3%80%82%E4%BD%A0%E4%B9%9F%E5%8F%AF%E4%BB%A5%E5%8F%91%E7%8E%B0%E4%BF%9D%E5%AD%98%E6%95%B0%E6%8D%AE%E5%88%B0%E5%85%A8%E5%B1%80%E5%91%BD%E5%90%8D%E7%A9%BA%E9%97%B4%E6%98%AF%E5%BE%88%E6%96%B9%E4%BE%BF%E7%9A%84%EF%BC%8C%E8%BF%99%E6%A0%B7%E4%BD%A0%E5%B0%B1%E5%8F%AF%E4%BB%A5%E5%9C%A8%E5%88%9D%E5%A7%8B%E5%8C%96%E6%B8%B2%E6%9F%93%E4%B9%8B%E5%90%8E%E8%AE%BF%E9%97%AE%E5%AE%83%EF%BC%8C%E4%BE%8B%E5%A6%82%E5%9C%A8%E8%BF%87%E6%B8%A1%E6%9C%9F%E9%97%B4%E3%80%82%E4%BD%A0%E5%8F%AF%E4%BB%A5%E4%BD%BF%E7%94%A8%E9%97%AD%E5%8C%85%E5%AE%9E%E7%8E%B0%E5%AE%83%EF%BC%8C%E6%88%96%E8%80%85%E7%AE%80%E5%8D%95%E5%9C%B0%E6%8C%87%E5%AE%9A%E5%8A%A0%E8%BD%BD%E6%95%B0%E6%8D%AE%E4%B8%BA%E5%85%A8%E5%B1%80%E5%8F%98%E9%87%8F%E3%80%82) ``` var data; // a global d3.json("path/to/file.json", function(error, json) { if (error) return console.warn(error); data = json; visualizeit(); }); ``` 默認情況下，大多數的瀏覽器不允許跨域訪問。為了支持跨域訪問，服務器必須設置頭Access-Control-Allow-Origin: \*。更多信息參見W3C的建議跨域資源分享。對于IE9，d3.xhr使用非標準的XDomainRequest支持跨域訪問。跨域資源分享：<http://www.w3.org/TR/cors/>XHR # d3.xhr(url\[, mimeType\]\[, callback\]) 為指定的url創建一個異步訪問。參數mimeType可能被指定為第二個參數，例如“text/plain”。如果指定了回調函數，那么請求就會使用GET方法立即發出，并且當資源被加載或者請求失敗之后回調函數就會被異步調用。如果有錯的話XMLHttpRequest對象代表了response。當錯誤發生時，response是未定義的。如果response有一個不成功狀態值，那么錯誤就是XMLHttpRequest對象。如果沒有指定回調函數，返回的request可以被分發使用xhr.get，xhr.post 或相近的，并使用xhr.on處理。 # xhr.header(name\[, value\]) ``` d3.csv("/path/to/file.csv") .header("header-name", "header-value") .get(function(error, data) { // callback }); ``` 如果指定了value，設置請求頭指定的name參數為指定的value值。如果value參數是null值，就移除指定名稱的請求頭，如果沒指定value值就會返回請求頭中指定名稱的當前值，請求頭名稱是大小寫敏感的。請求頭只可以在發送請求之前被修改。因此，如果你想指定一個請求頭就不能傳遞回調函數給d3.xhr constructor。而應該使用xhr.get或者相似的。例如： ``` d3.csv("/path/to/file.csv") .header("header-name", "header-value") .get(function(error, data) { // callback }); ``` # xhr.mimeType(\[type\]) 如果type參數被指定了，就會設置請求的mime類型為指定的值。如果type是null，就會清楚當前的mime類型（有的話）。如果沒有指定mime類型，就返回當前的mime類型，默認是null。Mime類型被用來設置"Accept"請求頭和覆蓋MimeType。請求頭只可以在發送請求之前被修改。 # xhr.responseType(type) 如果type被指定了，設置response類型，例如：""， "arraybuffer"，"blob"，"document"，或者 "text"。如果type沒有指定，就返回當前的response類型默認是””。 # xhr.response(value) 如果指定了value參數，就設置response的值函數為指定的函數。如果value沒有被指定，返回當前的response的值函數，默認就是驗證函數。response的值函數用來映射返回XMLHttpRequest對象為相應的數據類型。例如，對于文本請求，你可以使用 function(request) { return request.responseText; }，而對于JSON請求你可能使用function(request) { return JSON.parse(request.responseText); }。 # xhr.get(\[callback\]) 使用GET方法分發請求。如果指定了回調函數，在發送請求或者出錯的時候就會被異步調用。回調函數使用兩個參數調用：error（有的話）和response值。錯誤發生時response值是未定義的。如果沒有指定回調函數"load"和"error"監聽器會通過xhr.on注冊。這個方法是xhr.send的一個方便的包裝。 # xhr.post(\[data\]\[, callback\]) 使用POST方法分發這個請求，在請求體中可選地發送指定的data。如果指定了回調函數，在發送請求或者出錯的時候就會被異步調用。回調函數使用兩個參數調用：error（有的話）和response值。錯誤發生時response值是未定義的。如果沒有指定回調函數"load"和"error"監聽器會通過xhr.on注冊。這個方法是xhr.send的一個方便的包裝。使用URL編碼的例子： ``` d3.csv("/path/to/file.csv") .header("Content-Type", "application/x-www-form-urlencoded") .post("a=2&b=3", function(error, data) { // callback }); ``` An example using JSON encoding: ``` d3.csv("/path/to/file.csv") .header("Content-Type", "application/json") .post(JSON.stringify({a: 2, b: 3}), function(error, data) { // callback }); ``` # xhr.send(method\[, data\]\[, callback\]) 使用指定的方法分發這個請求，在請求體中可選地發送指定的data。如果指定了回調函數，在發送請求或者出錯的時候就會被異步調用。回調函數使用兩個參數調用：error（有的話）和response值。錯誤發生時response值是未定義的。如果沒有指定回調函數"load"和"error"監聽器會通過xhr.on注冊。這個方法是xhr.send的一個方便的包裝。 # xhr.abort() 中止正在發送的請求。參見XMLHttpRequest的中止： <http://www.w3.org/TR/XMLHttpRequest/#the-abort%28%29-method> # xhr.on(type\[, listener\]) 對指定的類型添加或者移除事件監聽器到這個請求。類型必須是以下類型之一： beforesend – 在請求發送之前，允許自定義標題等來進行設定。 progress – 用來監聽請求的過程。 load – 當請求成功的完成之后。 error –當請求不成功之后；包含4xx和5xx返回值。如果一個相同的類型監聽器已經被注冊，已存在的監聽器就會在新監聽器添加之前被移除。為了給同一個事件類型注冊多個監聽器，那么類型將遵循可選的命名空間，例如"load.foo" 和 "load.bar"。為了移除監聽器，傳遞null值為監聽器。如果沒有指定監聽器，為指定的類型（有的話）返回當前分配的監聽器。簡便方法通常，d3.xhr不會直接使用。取而代之的是使用類型特定的方法，例如： d3.text加載簡單文本，d3.json加載JSON，d3.xml 加載XML，d3.html 加載HTML，d3.csv加載逗號分隔值文件，d3.tsv加載制表符分隔文件。 # d3.text(url\[, mimeType\]\[, callback\]) 指定的URL創建一個文本文件請求。選項mimeType可以指定為第二參數，例如"text/plain"。如果指定了回調函數，請求將通過GET方法立即分發，當文件被加載或者請求失敗之后回調函數將被異步調用。回調函數的調用使用兩個參數：error（有的話）和response文本。錯誤發生時response文本是未定義的。如果沒有指定回調函數，返回的請求可能使用xhr.get或近似的方法分發，并使用xhr.on處理。 # d3.json(url\[, callback\]) 指定的URL創建一個JSON文件請求。選項mimeType可以指定為第二參數，例如"application/json"。如果指定了回調函數，請求將通過GET方法立即分發，當文件被加載或者請求失敗之后回調函數將被異步調用。回調函數的調用使用兩個參數：error（有的話）和解析過的JSON。錯誤發生時解析過的JSON是未定義的。如果沒有指定回調函數，返回的請求可能使用xhr.get或近似的方法分發，并使用xhr.on處理。 # d3.xml(url\[, mimeType\]\[, callback\]) 指定的URL創建一個XML文件請求。選項mimeType可以指定為第二參數，例如"application/xml"。如果指定了回調函數，請求將通過GET方法立即分發，當文件被加載或者請求失敗之后回調函數將被異步調用。回調函數的調用使用兩個參數：error（有的話）和解析為文檔的XML。錯誤發生時解析的XML是未定義的。如果沒有指定回調函數，返回的請求可能使用xhr.get或近似的方法分發，并使用xhr.on處理。 # d3.html(url\[, callback\]) 指定的URL創建一個文本文件請求。選項mimeType可以指定為第二參數，例如"text/html"。如果指定了回調函數，請求將通過GET方法立即分發，當文件被加載或者請求失敗之后回調函數將被異步調用。回調函數的調用使用兩個參數：error（有的話）和解析為文檔碎片的HTML。錯誤發生時解析后的HTML是未定義的。如果沒有指定回調函數，返回的請求可能使用xhr.get或近似的方法分發，并使用xhr.on處理。 # d3.csv(url\[, accessor\]\[, callback\]) 指定的URL創建一個CSV文件請求。選項mimeType可以指定為第二參數，例如"text/csv"。如果指定了回調函數，請求將通過GET方法立即分發，當文件被加載或者請求失敗之后回調函數將被異步調用。回調函數的調用使用兩個參數：error（有的話）和每個RFC 4180解析的行數組。錯誤發生時行數組是未定義的。如果沒有指定回調函數，返回的請求可能使用xhr.get或近似的方法分發，并使用xhr.on處理。 # d3.tsv(url\[, accessor\]\[, callback\]) 指定的URL創建一個文本文件請求。選項mimeType可以指定為第二參數，例如"text/tab-separated-values"。如果指定了回調函數，請求將通過GET方法立即分發，當文件被加載或者請求失敗之后回調函數將被異步調用。回調函數的調用使用兩個參數：error（有的話）和每個RFC 4180解析的行數組。錯誤發生時行數組是未定義的。如果沒有指定回調函數，返回的請求可能使用xhr.get或近似的方法分發，并使用xhr.on處理。 2014年11月22日 00:11:22 gulu翻譯