{hero}

按钮.按钮.可用

始于:Buttons 3.0.0

确保在初始化按钮之前已满足所有要求。
请注意 - 此属性需要 按钮 扩展,适用于 DataTables。

说明

某些按钮类型(尤其是文件导出按钮)可能取决于 Web 浏览器中某些 API 是否可用,且外部第三方库是否已加载。例如,pdfHtml5 按钮类型取决于 FileReader API 以及 pdfMake 库。

此方法为按钮开发者提供了这样的能力:确保在按钮显示给最终用户之前已满足其按钮的任何依赖项。如果函数返回 false,则按钮不向最终用户显示。

类型

函数 available( dt, config )

说明

此函数可用来确定最终用户的 Web 浏览器是否提供按钮正常运行所需的函数和库。如果函数返回 false,因为这些要求尚未得到满足,那么按钮将不向最终用户显示。

参数
返回

函数应返回一个布尔值 - true 表示按钮要求可用,false 表示不可用。

默认

  • 值:

默认函数取决于按钮类型。请参阅按钮类型文档。

示例

确保 FileReader API 可用

new DataTable('#myTable', {
	layout: {
		topEnd: {
			buttons: [
				{
					text: 'FileReader available',
					available: function (dt, config) {
						return window.FileReader !== undefined;
					}
				}
			]
		}
	}
});