com.aspose.words

Property Getters/Setters Detail

• getFormatCode/setFormatCode

  public java.lang.String getFormatCode() / public void setFormatCode(java.lang.String value)
  

  Gets or sets the format code applied to a data label.

  Number formatting is used to change the way a value appears in data label and can be used in some very creative ways. The examples of number formats:

  Number - "#,##0.00"

  Currency - "\"$\"#,##0.00"

  Time - "[$-x-systime]h:mm:ss AM/PM"

  Date - "d/mm/yyyy"

  Percentage - "0.00%"

  Fraction - "# ?/?"

  Scientific - "0.00E+00"

  Text - "@"

  Accounting - "_-\"$\"* #,##0.00_-;-\"$\"* #,##0.00_-;_-\"$\"* \"-\"??_-;_-@_-"

  Custom with color - "[Red]-#,##0.0"

  Example:

  Shows how to set formatting for chart values.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add a column chart, and then clear its demo data series to start with a clean chart.
  Shape shape = builder.insertChart(ChartType.COLUMN, 500.0, 300.0);
  Chart chart = shape.getChart();
  chart.getSeries().clear();
  
  // Add a custom series to the chart with categories for the X-axis,
  // and large respective numeric values for the Y-axis. 
  chart.getSeries().add("Aspose Test Series",
          new String[]{"Word", "PDF", "Excel", "GoogleDocs", "Note"},
          new double[]{1900000.0, 850000.0, 2100000.0, 600000.0, 1500000.0});
  
  // Set the number format of the Y-axis tick labels to not group digits with commas. 
  chart.getAxisY().getNumberFormat().setFormatCode("#,##0");
  
  // This flag can override the above value and draw the number format from the source cell.
  Assert.assertFalse(chart.getAxisY().getNumberFormat().isLinkedToSource());
  
  doc.save(getArtifactsDir() + "Charts.SetNumberFormatToChartAxis.docx");

  Example:

  Shows how to enable and configure data labels for a chart series.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add a line chart, then clear its demo data series to start with a clean chart,
  // and then set a title.
  Shape shape = builder.insertChart(ChartType.LINE, 500.0, 300.0);
  Chart chart = shape.getChart();
  chart.getSeries().clear();
  chart.getTitle().setText("Monthly sales report");
  
  // Insert a custom chart series with months as categories for the X-axis,
  // and respective decimal amounts for the Y-axis.
  ChartSeries series = chart.getSeries().add("Revenue", 
      new String[] { "January", "February", "March" }, 
      new double[] { 25.611d, 21.439d, 33.750d });
  
  // Enable data labels, and then apply a custom number format for values displayed in the data labels.
  // This format will treat displayed decimal values as millions of US Dollars.
  series.hasDataLabels(true);
  ChartDataLabelCollection dataLabels = series.getDataLabels();
  dataLabels.setShowValue(true);
  dataLabels.getNumberFormat().setFormatCode("\"US$\" #,##0.000\"M\"");
  
  doc.save(getArtifactsDir() + "Charts.DataLabelNumberFormat.docx");

• isLinkedToSource/isLinkedToSource

  public boolean isLinkedToSource() / public void isLinkedToSource(boolean value)
  

  Specifies whether the format code is linked to a source cell. Default is true.

  The NumberFormat will be reset to general if format code is linked to source.

  Example:

  Shows how to set formatting for chart values.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add a column chart, and then clear its demo data series to start with a clean chart.
  Shape shape = builder.insertChart(ChartType.COLUMN, 500.0, 300.0);
  Chart chart = shape.getChart();
  chart.getSeries().clear();
  
  // Add a custom series to the chart with categories for the X-axis,
  // and large respective numeric values for the Y-axis. 
  chart.getSeries().add("Aspose Test Series",
          new String[]{"Word", "PDF", "Excel", "GoogleDocs", "Note"},
          new double[]{1900000.0, 850000.0, 2100000.0, 600000.0, 1500000.0});
  
  // Set the number format of the Y-axis tick labels to not group digits with commas. 
  chart.getAxisY().getNumberFormat().setFormatCode("#,##0");
  
  // This flag can override the above value and draw the number format from the source cell.
  Assert.assertFalse(chart.getAxisY().getNumberFormat().isLinkedToSource());
  
  doc.save(getArtifactsDir() + "Charts.SetNumberFormatToChartAxis.docx");