ExcelScript.ChartLegend interface

Пакет:

ExcelScript

Представляет легенду в диаграмме.

Комментарии

Используется

• ExcelScript.Chart: getLegend

Примеры

/**
 * This sample configures the chart legend.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Configure the legend.
  const legend = chart.getLegend();
  legend.setPosition(ExcelScript.ChartLegendPosition.bottom);
  legend.setVisible(true);
}

Методы

getFormat()	Представляет форматирование легенды диаграммы, включая заливку и шрифт.
getHeight()	Указывает высоту (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.
getLeft()	Указывает левое значение (в пунктах) условных обозначений на диаграмме. Значение равно, null если легенда не видна.
getLegendEntries()	Представляет коллекцию объектов legendEntries в условных обозначениях.
getOverlay()	Указывает, должно ли условные обозначения диаграммы перекрываться с основным текстом диаграммы.
getPosition()	Указывает положение условных обозначений на диаграмме. Дополнительные сведения см. в этой ExcelScript.ChartLegendPosition статье.
getShowShadow()	Указывает, имеет ли условный обозначения тень на диаграмме.
getTop()	Указывает верхнюю часть условных обозначений диаграммы.
getVisible()	Указывает, отображается ли условный обозначения диаграммы.
getWidth()	Задает ширину (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.
setHeight(height)	Указывает высоту (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.
setLeft(left)	Указывает левое значение (в пунктах) условных обозначений на диаграмме. Значение равно, null если легенда не видна.
setOverlay(overlay)	Указывает, должно ли условные обозначения диаграммы перекрываться с основным текстом диаграммы.
setPosition(position)	Указывает положение условных обозначений на диаграмме. Дополнительные сведения см. в этой ExcelScript.ChartLegendPosition статье.
setShowShadow(showShadow)	Указывает, имеет ли условный обозначения тень на диаграмме.
setTop(top)	Указывает верхнюю часть условных обозначений диаграммы.
setVisible(visible)	Указывает, отображается ли условный обозначения диаграммы.
setWidth(width)	Задает ширину (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

Сведения о методе

getFormat()

Представляет форматирование легенды диаграммы, включая заливку и шрифт.

getFormat(): ChartLegendFormat;

Возвращаемое значение

ExcelScript.ChartLegendFormat

getHeight()

Указывает высоту (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

getHeight(): number;

Возвращаемое значение

number

getLeft()

Указывает левое значение (в пунктах) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

getLeft(): number;

Возвращаемое значение

number

getLegendEntries()

Представляет коллекцию объектов legendEntries в условных обозначениях.

getLegendEntries(): ChartLegendEntry[];

Возвращаемое значение

ExcelScript.ChartLegendEntry[]

getOverlay()

Указывает, должно ли условные обозначения диаграммы перекрываться с основным текстом диаграммы.

getOverlay(): boolean;

Возвращаемое значение

boolean

getPosition()

Указывает положение условных обозначений на диаграмме. Дополнительные сведения см. в этой ExcelScript.ChartLegendPosition статье.

getPosition(): ChartLegendPosition;

Возвращаемое значение

ExcelScript.ChartLegendPosition

getShowShadow()

Указывает, имеет ли условный обозначения тень на диаграмме.

getShowShadow(): boolean;

Возвращаемое значение

boolean

getTop()

Указывает верхнюю часть условных обозначений диаграммы.

getTop(): number;

Возвращаемое значение

number

getVisible()

Указывает, отображается ли условный обозначения диаграммы.

getVisible(): boolean;

Возвращаемое значение

boolean

getWidth()

Задает ширину (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

getWidth(): number;

Возвращаемое значение

number

setHeight(height)

Указывает высоту (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

setHeight(height: number): void;

Параметры

height

number

Возвращаемое значение

void

setLeft(left)

Указывает левое значение (в пунктах) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

setLeft(left: number): void;

Параметры

left

number

Возвращаемое значение

void

setOverlay(overlay)

Указывает, должно ли условные обозначения диаграммы перекрываться с основным текстом диаграммы.

setOverlay(overlay: boolean): void;

Параметры

overlay

boolean

Возвращаемое значение

void

setPosition(position)

Указывает положение условных обозначений на диаграмме. Дополнительные сведения см. в этой ExcelScript.ChartLegendPosition статье.

setPosition(position: ChartLegendPosition): void;

Параметры

position

ExcelScript.ChartLegendPosition

Возвращаемое значение

void

Примеры

/**
 * This sample sets the legend position on a chart.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Position the legend on the right side.
  chart.getLegend().setPosition(ExcelScript.ChartLegendPosition.right);
}

setShowShadow(showShadow)

Указывает, имеет ли условный обозначения тень на диаграмме.

setShowShadow(showShadow: boolean): void;

Параметры

showShadow

boolean

Возвращаемое значение

void

setTop(top)

Указывает верхнюю часть условных обозначений диаграммы.

setTop(top: number): void;

Параметры

top

number

Возвращаемое значение

void

setVisible(visible)

Указывает, отображается ли условный обозначения диаграммы.

setVisible(visible: boolean): void;

Параметры

visible

boolean

Возвращаемое значение

void

Примеры

/**
 * This sample hides the chart legend.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Hide the legend.
  chart.getLegend().setVisible(false);
}

setWidth(width)

Задает ширину (в точках) условных обозначений на диаграмме. Значение равно, null если легенда не видна.

setWidth(width: number): void;

Параметры

width

number

Возвращаемое значение

void