Servicio SFDocuments.Chart

The Chart service provides a set of properties and methods to handle charts in Calc documents. With this service it is possible to:

• Acceder a los objetos de gráfico en los documentos de Calc y manipular sus propiedades.

• Crear e insertar gráficos nuevos en un documento de Calc.

• Exportar los gráficos como archivos de imagen.

Nombres de gráfico

Los gráficos pueden tener dos nombres diferentes:

• Un nombre interno que LibreOffice otorga en cuanto se crea el objeto del gráfico (normalmente «Objeto 1», «Objeto 2», y así sucesivamente).

• Un nombre personalizado que puede definirse al pulsar con el botón secundario del ratón sobre el gráfico y eligiendo Nombre en el menú contextual.

El servicio Chart utiliza principalmente el nombre definido por el usuario para acceder a un objeto de gráfico. Si no existe, se utiliza el nombre interno.

Invocación del servicio

Antes de utilizar el servicio Chart, es necesario cargar o importar la biblioteca ScriptForge:

• Para cargar la biblioteca ScriptForge que necesitan las macros de Basic se debe usar la siguiente declaración:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Los scripts de Python necesitan importar el módulo scriptforge:
from scriptforge import CreateScriptService

The Chart service is instantiated from a Calc service instance either using the Charts or CreateChart methods.

The example below creates a Chart service instance from an existing chart in the current Calc document:

    GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
    Dim oDoc as Object, oChart as Object
    Set oDoc = CreateScriptService("Calc")
    Set oChart = oDoc.Charts("Sheet1", "Object 1")
  

The following example instantiate the Chart service by creating a new chart object based on the data contained in the range "Sheet1.A1:C10".

    Dim oDoc as Object, oChart as Object
    Set oDoc = CreateScriptService("Calc")
    Set oChart = oDoc.CreateChart("My Chart", "Sheet1", "Sheet1.A1:C10")
  

Read the CreateChart method description to learn more about its arguments.

Los ejemplos anteriores pueden escribirse en Python de esta manera:

    from scriptforge import CreateScriptService
    doc = CreateScriptService("Calc")
    chart = doc.Charts("Sheet1", "Object 1")
  

    doc = CreateScriptService("Calc")
    chart = doc.CreateChart("My Chart", "Sheet1", "Sheet1.A1:C10")
  

Propiedades

Crear un gráfico

Considere los siguientes datos en el intervalo «A1:B6» de una hoja llamada «Informe».

The examples below in Basic and Python show how to create a line chart from this data with legends.

    oDoc = CreateScriptService("Calc")
    oChart = oDoc.CreateChart("Samples", "Report", "Report.A1:B6")
    oChart.ChartType = "Line"
    oChart.Legend = True
    oChart.Resize(1000, 1000, 25000, 15000)
  

    doc = CreateScriptService("Calc")
    chart = doc.CreateChart("Samples", "Report", "Report.A1:B6")
    chart.ChartType = "Line"
    chart.Legend = True
    chart.Resize(1000, 1000, 25000, 15000)
  

The chart does not need to be created in the same sheet where the data is located. It can be created in any existing sheet in the current file by specifying the sheet name in the second argument of the CreateChart method.

Métodos

ExportToFile

Saves the chart as an image file in a specified location. Returns True if the image file could be successfully created.

chart.ExportToFile(filename: str, imagetype: str = "png", overwrite: bool = False): bool

filename: Identifies the path and file name where the image will be saved. It must follow the notation defined in SF_FileSystem.FileNaming.

imagetype: The name of the image type to be created. The following values are accepted: "gif", "jpeg", "png" (default), "svg" and "tiff".

overwrite: Specifies if the destination file can be overwritten (Default = False).

      oChart.ExportToFile("C:\Temp\myChart.svg", ImageType := "svg", Overwrite := True)
    

      chart.ExportToFile(r"C:\Temp\myChart.svg", imagetype="svg", overwrite=True)
    

Resize

Changes the position of the chart in the current sheet and modifies its width and height. Returns True if resizing was successful.

chart.Resize([xpos: int], [ypos: int], [width: int], [height: int]): bool

xpos, ypos: Specify the new X and Y positions of the chart. If any of these values are omitted or if negative values are provided, the corresponding positions are left unchanged.

width: Specify the new width of the chart. If this argument is omitted or if a negative value is provided, the chart width is left unchanged.

height: Specify the new height of the chart. If this argument is omitted or if a negative value is provided, the chart height is left unchanged.

All arguments are provided as integer values that correspond to 1/100 of a millimeter.

      ' Changes only X and Y position
      oChart.Rezise(1000, 3000)
      ' Cambia solo la anchura y la altura del gráfico
      oChart.Resize(, , 25000, 12500)
      ' Keyword arguments are supported
      oChart.Resize(Width := 25000, Height := 12500)
    

      chart.Rezise(1000, 3000)
      chart.Resize(-1, -1, 20000, 20000)
      chart.Resize(width=25000, height=12500)
    

Todas las rutinas o identificadores BASIC de ScriptForge precedidas por guion bajo «_» están reservadas para uso interno. No deben utilizarse en macros BASIC o secuencias Python.