Excel.ChartCollection class
Uma coleção de todos os objetos Chart de uma planilha.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.1]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| count | Retorna o número de gráficos da planilha. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(type, source |
Cria um novo gráfico. |
| add(type, source |
Cria um novo gráfico. |
| get |
Retorna o número de gráficos da planilha. |
| get |
Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles. |
| get |
Obtém um gráfico com base em sua posição no conjunto. |
| get |
Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles. Se o gráfico não existir, esse método retornará um objeto com sua |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
Eventos
| on |
Ocorre quando um gráfico é ativado. |
| on |
Ocorre quando um novo gráfico é adicionado à planilha. |
| on |
Ocorre quando um gráfico é desativado. |
| on |
Ocorre quando um gráfico é excluído. |
Detalhes da propriedade
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
count
Retorna o número de gráficos da planilha.
readonly count: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.1]
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.Chart[];Valor da propriedade
Detalhes do método
add(type, sourceData, seriesBy)
Cria um novo gráfico.
add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy): Excel.Chart;Parâmetros
- type
- Excel.ChartType
Representa o tipo de um gráfico. Consulte Excel.ChartType para obter detalhes.
- sourceData
- Excel.Range
O Range objeto correspondente aos dados de origem.
- seriesBy
- Excel.ChartSeriesBy
Opcional. Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Consulte Excel.ChartSeriesBy para obter detalhes.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
add(type, sourceData, seriesBy)
Cria um novo gráfico.
add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart;Parâmetros
- type
-
"Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"
Representa o tipo de um gráfico. Consulte Excel.ChartType para obter detalhes.
- sourceData
- Excel.Range
O Range objeto correspondente aos dados de origem.
- seriesBy
-
"Auto" | "Columns" | "Rows"
Opcional. Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Consulte Excel.ChartSeriesBy para obter detalhes.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
getCount()
Retorna o número de gráficos da planilha.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[Conjunto de apis: ExcelApi 1.4]
getItem(name)
Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles.
getItem(name: string): Excel.Chart;Parâmetros
- name
-
string
Nome do gráfico a recuperar.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
getItemAt(index)
Obtém um gráfico com base em sua posição no conjunto.
getItemAt(index: number): Excel.Chart;Parâmetros
- index
-
number
Valor de índice do objeto a ser recuperado. Indexados com zero.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
getItemOrNullObject(name)
Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles. Se o gráfico não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getItemOrNullObject(name: string): Excel.Chart;Parâmetros
- name
-
string
Nome do gráfico a recuperar.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.4]
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.ChartCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.ChartCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.ChartCollectionData;Retornos
Detalhes do evento
onActivated
Ocorre quando um gráfico é ativado.
readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.8]
onAdded
Ocorre quando um novo gráfico é adicionado à planilha.
readonly onAdded: OfficeExtension.EventHandlers<Excel.ChartAddedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.8]
onDeactivated
Ocorre quando um gráfico é desativado.
readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.8]
onDeleted
Ocorre quando um gráfico é excluído.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.ChartDeletedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.8]