[]
        
首页
开发者学堂
文档
论坛
市场
生态机会
活动
在线咨询 立即试用
(Showing Draft Content)

GC.Spread.Sheets.Slicers.DOMTableSlicer

Class: DOMTableSlicer

Sheets.Slicers.DOMTableSlicer

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new DOMTableSlicer(name, table, columnName)

表示一个切片器。

Parameters

Name Type Description
name string 切片器名称。
table Table 与切片器关联的表格。
columnName string 表格列的名称。

Overrides

FloatingObject.constructor

Properties

typeName

• typeName: string

表示用于支持序列化的类型名称字符串。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('floatingObject', 10, 10, 64, 30);
console.log(customFloatingObject.typeName); // "0"

Inherited from

FloatingObject.typeName

Methods

allowMove

▸ allowMove(value?): any

获取或设置是否禁用移动浮动对象。

example

//此示例禁止移动或调整浮动对象大小。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.allowResize(false);
customFloatingObject.allowMove(false);
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 是否禁用移动浮动对象的设置。

Returns

any

如果未设置值,则返回是否禁用移动浮动对象的设置;否则返回浮动对象。

Inherited from

FloatingObject.allowMove


allowResize

▸ allowResize(value?): any

获取或设置是否禁用调整浮动对象大小。

example

//此示例禁止移动或调整浮动对象大小。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.allowResize(false);
customFloatingObject.allowMove(false);
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 是否禁用调整浮动对象大小的设置。

Returns

any

如果未设置值,则返回是否禁用调整浮动对象大小的设置;否则返回浮动对象。

Inherited from

FloatingObject.allowResize


alt

▸ alt(value?): any

获取或设置浮动对象的替代文本(用于屏幕阅读器)。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('f1', 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
customFloatingObject.alt("一个按钮");
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? string 浮动对象的替代文本。

Returns

any

浮动对象的替代文本。

Inherited from

FloatingObject.alt


captionName

▸ captionName(value?): any

获取或设置切片器的标题名称。

example

//此示例使用captionName方法。
//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
//切片器样式
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
//更改切片器属性。
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.captionName("S1");
slicer.style(style1);

Parameters

Name Type Description
value? string 切片器的标题名称。captionName属性显示在切片器的标题栏中。

Returns

any

如果未设置值,返回切片器的标题名称;否则返回切片器。


cloneContent

▸ cloneContent(): HTMLElement

获取实例当前内容的副本。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('f1', 10, 10, 64, 30);
customFloatingObject.content(createButton('button 1', '64px', '30px'));
activeSheet.floatingObjects.add(customFloatingObject);

var btn = customFloatingObject.cloneContent();
btn.innerText = 'button 2';
customFloatingObject.content(btn);

function createButton (text, width, height) {
    var btn = document.createElement('button');
    btn.style.width = width;
    btn.style.height = height;
    btn.innerText = text;
    return btn;
}

Returns

HTMLElement

实例当前内容的副本。

Inherited from

FloatingObject.cloneContent


columnCount

▸ columnCount(value?): any

获取或设置切片器的列数。

example

//此示例更改切片器列数
//创建表格
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
//向工作表添加切片器并返回切片器实例。
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
console.log(slicer.columnCount());
slicer.columnCount(3);
console.log(slicer.columnCount());

Parameters

Name Type Description
value? number 切片器的列数。切片器的columnCount属性指定切片器内每行显示的列数。

Returns

any

如果未设置值,返回切片器的列数;否则返回切片器。


content

▸ content(value?): any

获取或设置自定义浮动对象的内容。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('f1', 10, 10, 64, 30);
customFloatingObject.content(createButton('button 1', '64px', '30px'));
activeSheet.floatingObjects.add(customFloatingObject);

console.log(customFloatingObject.content()); // 获取当前内容,结果是文本为"button 1"的按钮元素。
customFloatingObject.content(createButton('button 2', '64px', '30px')); // 设置新内容。

function createButton (text, width, height) {
    var btn = document.createElement('button');
    btn.style.width = width;
    btn.style.height = height;
    btn.innerText = text;
    return btn;
}

Parameters

Name Type Description
value? HTMLElement 自定义浮动对象的内容。

Returns

any

如果未设置值,则返回自定义浮动对象的内容;否则返回浮动对象。

Inherited from

FloatingObject.content


disableResizingAndMoving

▸ disableResizingAndMoving(value?): any

获取或设置是否禁用切片器的调整大小和移动。

example

//此示例阻止移动或调整切片器大小。
//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
//切片器样式
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
//更改切片器属性。
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.disableResizingAndMoving(true);
slicer.style(style1);

Parameters

Name Type Description
value? boolean 是否禁用切片器的调整大小和移动的设置。切片器的disableResizingAndMoving属性指定是否允许用户调整切片器控件的大小或移动它,限制对其大小或位置的任何更改。

Returns

any

如果未设置值,返回是否禁用切片器的调整大小和移动;否则返回切片器。


dynamicMove

▸ dynamicMove(value?): any

获取或设置当隐藏或显示、调整大小或移动行或列时,对象是否移动。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示当隐藏或显示、调整大小或移动行或列时,对象是否移动的值。

Returns

any

如果未设置值,则返回此浮动对象是否动态移动;否则返回浮动对象。

Inherited from

FloatingObject.dynamicMove


dynamicSize

▸ dynamicSize(value?): any

获取或设置当隐藏或显示、调整大小或移动行或列时,对象的大小是否改变。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示当隐藏或显示、调整大小或移动行或列时,对象的大小是否改变的值。

Returns

any

如果未设置值,则返回此浮动对象是否动态改变大小;否则返回浮动对象。

Inherited from

FloatingObject.dynamicSize


endColumn

▸ endColumn(value?): any

获取或设置浮动对象位置的结束列索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的结束列索引。

Returns

any

如果未设置值,则返回浮动对象位置的结束列索引;否则返回浮动对象。

Inherited from

FloatingObject.endColumn


endColumnOffset

▸ endColumnOffset(value?): any

获取或设置浮动对象相对于结束列的偏移量。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象相对于结束列的偏移量。

Returns

any

如果未设置值,则返回浮动对象相对于结束列的偏移量;否则返回浮动对象。

Inherited from

FloatingObject.endColumnOffset


endRow

▸ endRow(value?): any

获取或设置浮动对象位置的结束行索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的结束行索引。

Returns

any

如果未设置值,则返回浮动对象位置的结束行索引;否则返回浮动对象。

Inherited from

FloatingObject.endRow


endRowOffset

▸ endRowOffset(value?): any

获取或设置相对于浮动对象结束行的偏移量。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 相对于浮动对象结束行的偏移量。

Returns

any

如果未设置值,则返回相对于浮动对象结束行的偏移量;否则返回浮动对象。

Inherited from

FloatingObject.endRowOffset


fixedPosition

▸ fixedPosition(value): any

获取或设置浮动对象的位置是否固定。当 fixedPosition 为 true 时,dynamicMove 和 dynamicSize 将被禁用。

example

//此示例将对象的位置设置为固定。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.fixedPosition(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type
value boolean

Returns

any

如果未设置值,则返回浮动对象的位置是否固定;否则返回浮动对象。

Inherited from

FloatingObject.fixedPosition


getHost

▸ getHost(): HTMLElement[]

获取自定义内容的DOM宿主。

Returns

HTMLElement[]

Inherited from

FloatingObject.getHost


height

▸ height(value?): any

获取或设置浮动对象的高度。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的高度。

Returns

any

如果未设置值,则返回浮动对象的高度;否则返回浮动对象。

Inherited from

FloatingObject.height


isLocked

▸ isLocked(value?): any

获取或设置此浮动对象是否被锁定。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
customFloatingObject.isLocked(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.options.isProtected = true;

Parameters

Name Type Description
value? boolean 指示此浮动对象是否被锁定的值。

Returns

any

如果未设置值,则返回此浮动对象是否被锁定;否则返回浮动对象。

Inherited from

FloatingObject.isLocked


isSelected

▸ isSelected(value?): any

获取或设置此浮动对象是否被选中。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isSelected(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示此浮动对象是否被选中的值。

Returns

any

如果未设置值,则返回此浮动对象是否被选中;否则返回浮动对象。

Inherited from

FloatingObject.isSelected


isVisible

▸ isVisible(value?): any

获取或设置此浮动对象是否可见。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示此浮动对象是否可见的值。

Returns

any

如果未设置值,则返回此浮动对象是否可见;否则返回浮动对象。

Inherited from

FloatingObject.isVisible


itemHeight

▸ itemHeight(value?): any

获取或设置切片器的项目高度。

example

//此示例更改切片器项目高度。
//创建表格
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);

var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
console.log(slicer.itemHeight()); // 21
slicer.itemHeight(35);
console.log(slicer.itemHeight()); // 35

Parameters

Name Type Description
value? number 切片器的项目高度。切片器的itemHeight属性指定切片器内每个项目或行的高度。

Returns

any

如果未设置值,返回切片器的项目高度;否则返回切片器。


name

▸ name(value?): any

获取或设置切片器的名称。

example

//这个示例使用了name方法。
//创建一个表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
console.log(slicer.name());
slicer.name("slicer2");
console.log(slicer.name());

Parameters

Name Type Description
value? string 切片器的名称。该名称在工作簿中的所有切片器中必须是唯一的。

Returns

any

如果未设置值,返回切片器的名称;否则返回切片器。

Overrides

FloatingObject.name


refreshContent

▸ refreshContent(): void

刷新浮动对象中的内容。用户应该重写此方法以使其内容与浮动对象保持同步。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('floatingObject', 10, 10, 64, 30);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
// 隐藏浮动对象
customFloatingObject.isVisible(false);
activeSheet.floatingObjects.add(customFloatingObject);

// 显示浮动对象
customFloatingObject.isVisible(true);
customFloatingObject.refreshContent(customFloatingObject.content());

Returns

void

Inherited from

FloatingObject.refreshContent


showHeader

▸ showHeader(value?): any

获取或设置是否显示切片器标题。

example

//此示例隐藏切片器标题。
//创建表格
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
//切片器样式
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
//向工作表添加切片器并返回切片器实例。
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.showHeader(false);
slicer.style(style1);

Parameters

Name Type Description
value? boolean 切片器的显示标题设置。切片器的showHeader属性指定是否在切片器中显示包含标题和筛选相关控件的标题栏。

Returns

any

如果未设置值,返回是否显示切片器标题;否则返回切片器。


showNoDataItems

▸ showNoDataItems(value?): any

获取或设置是否显示切片器的无数据项目。

example

//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
//更改切片器属性。
slicer.showNoDataItems(false);

Parameters

Name Type Description
value? boolean 切片器的显示无数据项目设置。切片器的showNoDataItems属性指定是否在切片器中显示在连接的透视表或数据源中没有关联数据的项目。

Returns

any

如果未设置值,返回是否显示切片器的无数据项目;否则返回切片器。


showNoDataItemsInLast

▸ showNoDataItemsInLast(value?): any

获取或设置是否最后显示无数据项目。

example

//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
//更改切片器属性。
slicer.showNoDataItemsInLast(false);

Parameters

Name Type Description
value? boolean 切片器的最后显示无数据项目设置。切片器的showNoDataItemsInLast属性指定在呈现项目时是否将没有关联数据的项目显示在切片器列表的末尾。

Returns

any

如果未设置值,返回是否最后显示无数据项目;否则返回切片器。


sortState

▸ sortState(value?): any

获取或设置切片器的排序状态。

example

//此示例设置切片器中项目的排序顺序。
//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
// 切片器样式
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
//设置切片器属性
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.sortState(GC.Spread.Sheets.SortState.descending);
slicer.style(style1);

Parameters

Name Type Description
value? SortState 切片器的排序状态。切片器的sortState属性指定应用于切片器内项目的当前排序状态,指示它们是否按升序或降序排序。

Returns

any

如果未设置值,返回切片器的排序状态;否则返回切片器。


startColumn

▸ startColumn(value?): any

获取或设置浮动对象位置的起始列索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的起始列索引。

Returns

any

如果未设置值,则返回浮动对象位置的起始列索引;否则返回浮动对象。

Inherited from

FloatingObject.startColumn


startColumnOffset

▸ startColumnOffset(value?): any

获取或设置浮动对象相对于起始列的偏移量。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象相对于起始列的偏移量。

Returns

any

如果未设置值,则返回浮动对象相对于起始列的偏移量;否则返回浮动对象。

Inherited from

FloatingObject.startColumnOffset


startRow

▸ startRow(value?): any

获取或设置浮动对象位置的起始行索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的起始行索引。

Returns

any

如果未设置值,则返回浮动对象位置的起始行索引;否则返回浮动对象。

Inherited from

FloatingObject.startRow


startRowOffset

▸ startRowOffset(value?): any

获取或设置浮动对象相对于起始行的偏移量。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象相对于起始行的偏移量。

Returns

any

如果未设置值,则返回浮动对象相对于起始行的偏移量;否则返回浮动对象。

Inherited from

FloatingObject.startRowOffset


style

▸ style(value?): any

获取或设置切片器的样式。

example

// 此示例使用内置样式。
//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
// 切片器样式
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
//更改切片器属性
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.style(style1);

Parameters

Name Type Description
value? string | SlicerStyle 切片器的样式或样式名称。切片器的style属性指定应用于切片器的视觉外观和格式样式,定义其整体外观和呈现方式。

Returns

any

如果未设置值,返回切片器的样式;否则返回切片器。


toImageSrc

▸ toImageSrc(): string

获取切片器图像的Base64字符串类型的src。

example

let slicerImageSrc = sheet.slicers.all()[0].toImageSrc();

Returns

string

返回切片器图像的Base64 src字符串。


toImageSrcAsync

▸ toImageSrcAsync(): Promise<string>

获取切片器图像的Base64字符串类型的src。

example

let slicerImageSrc = await sheet.slicers.all()[0].toImageSrcAsync();

Returns

Promise<string>

返回切片器图像的Base64 src字符串。


visuallyNoDataItems

▸ visuallyNoDataItems(value?): any

获取或设置是否在视觉上区分没有数据的项目。

example

//创建表格
var spread = new GC.Spread.Sheets.Workbook('ss');
var activeSheet = spread.getActiveSheet();
var datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
var dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
var slicer = new GC.Spread.Sheets.Slicers.DOMTableSlicer('slicer1', table, 'Name');
// 将项目切片器添加到 DOM 树中。
// 其中 "slicerHost" 是你要用于承载切片器 DOM 元素的 div 容器。
var slicerHost = document.getElementById("slicerHost");
slicerHost.appendChild(slicer.cloneContent()); // 把切片器添加到 DOM 树中(完成挂载)
//更改切片器属性
slicer.visuallyNoDataItems(false);

Parameters

Name Type Description
value? boolean 无数据项目的设置。切片器的visuallyNoDataItems属性指定切片器内没有关联数据的项目的视觉表示或处理方式。

Returns

any

如果未设置值,返回是否在视觉上区分没有数据的项目;否则返回切片器。


width

▸ width(value?): any

获取或设置浮动对象的宽度。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的宽度。

Returns

any

如果未设置值,则返回浮动对象的宽度;否则返回浮动对象。

Inherited from

FloatingObject.width


x

▸ x(value?): any

获取或设置浮动对象的水平位置。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的水平位置。

Returns

any

如果未设置值,则返回浮动对象的水平位置;否则返回浮动对象。

Inherited from

FloatingObject.x


y

▸ y(value?): any

获取或设置浮动对象的垂直位置。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的垂直位置。

Returns

any

如果未设置值,则返回浮动对象的垂直位置;否则返回浮动对象。

Inherited from

FloatingObject.y