captionName Method

Gets or sets the caption name of the slicer.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Slicer(name, table, columnName);
var returnValue; // Type: string
returnValue = instance.captionName(value);

function captionName( 
   value : string
) : string;

Parameters

value: The caption name of the slicer.

Return Value

The caption name of the slicer.

Example

This example uses the captionName method.

Javascript

//create a table
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.addTableByDataSource("table1", 2, 2, datas);
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 GcSpread.Sheets.SlicerStyles.light4();
//add a slicer to the sheet and return the slicer instance.
var slicer = activeSheet.addSlicer("slicer1",table.name(),"Name");
 //change the slicer properties.
slicer.position(new GcSpread.Sheets.Point(100, 200));
slicer.captionName("S1");
slicer.style(style1);

Reference

Slicer type