Skip to content

Commit 87c47c0

Browse files
committed
Aspose.Slides for Java 25.1 API references
1 parent 8abc660 commit 87c47c0

File tree

17 files changed

+863
-67
lines changed

17 files changed

+863
-67
lines changed

content/java/english/com.aspose.slides/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ url: /com.aspose.slides/
249249
| [HSL](../com.aspose.slides/hsl) | Represents a Hue/Saturation/Luminance effect. |
250250
| [HandoutLayoutingOptions](../com.aspose.slides/handoutlayoutingoptions) | Represents the handout presentation layout mode for export. |
251251
| [HandoutType](../com.aspose.slides/handouttype) | Specifies how many slides and in what sequence will be placed on the page. |
252+
| [HeadingPair](../com.aspose.slides/headingpair) | Represents a 'Heading pair' property of the document. |
252253
| [Html5Options](../com.aspose.slides/html5options) | Represents a HTML5 exporting options. |
253254
| [HtmlExternalResolver](../com.aspose.slides/htmlexternalresolver) | Callback object used by HTML import routine to obtain referrenced objects such as images. |
254255
| [HtmlFormatter](../com.aspose.slides/htmlformatter) | Represents HTML file template. |
@@ -853,6 +854,7 @@ url: /com.aspose.slides/
853854
| [IGroupShapeLock](../com.aspose.slides/igroupshapelock) | Determines which operations are disabled on the parent GroupShape. |
854855
| [IHSL](../com.aspose.slides/ihsl) | Represents a Hue/Saturation/Luminance effect. |
855856
| [IHSLEffectiveData](../com.aspose.slides/ihsleffectivedata) | Represents a Hue/Saturation/Luminance effect. |
857+
| [IHeadingPair](../com.aspose.slides/iheadingpair) | Represents a 'Heading pair' property of the document. |
856858
| [IHtml5Options](../com.aspose.slides/ihtml5options) | Represents a HTML5 exporting options. |
857859
| [IHtmlExternalResolver](../com.aspose.slides/ihtmlexternalresolver) | Callback interface used by HTML import routine to obtain referrenced objects such as images. |
858860
| [IHtmlFormatter](../com.aspose.slides/ihtmlformatter) | Represents HTML file template. |

content/java/english/com.aspose.slides/chartseries/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Represents a chart series.
7474
| [getGapDepth()](#getGapDepth--) | Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart. |
7575
| [getFirstSliceAngle()](#getFirstSliceAngle--) | Specifies the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees). |
7676
| [getDoughnutHoleSize()](#getDoughnutHoleSize--) | Specifies the size of the hole in a doughnut chart (can be between 10 and 90 percents of the size of the plot area.). |
77-
| [getOverlap()](#getOverlap--) | Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). |
77+
| [getOverlap()](#getOverlap--) | Specifies how much bars and columns overlap on 2-D charts, as a percentage (from -100% to 100%). |
7878
| [getSecondPieSize()](#getSecondPieSize--) | Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents). |
7979
| [hasSeriesLines()](#hasSeriesLines--) | Determines whether there are series lines for this series and kindred series. |
8080
| [getBubbleSizeRepresentation()](#getBubbleSizeRepresentation--) | Specifies how the bubble size values are represented on the bubble chart. |
@@ -727,11 +727,11 @@ public final byte getOverlap()
727727
```
728728

729729

730-
Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.Overlap read/write property for change value. Read-only byte.
730+
Specifies how much bars and columns overlap on 2-D charts, as a percentage (from -100% to 100%). This is the property not only of this series but of all series of parent series group. It is a projection of the appropriate property in the parent series group, and so this property is read-only. To change the value, use the ParentSeriesGroup.Overlap read/write property. Read-only byte.
731731

732732
--------------------
733733

734-
This is the projection of the property ParentSeriesGroup.Overlap.
734+
Overlap specifies the degree of overlap or spacing between bars and columns as a percentage of their width: - -100%: Maximum spacing (bars are completely separated). - 0%: Bars are placed side by side without overlap or spacing. - 100%: Maximum overlap (bars completely overlap each other). This is a projection of the property ParentSeriesGroup.Overlap.
735735

736736
**Returns:**
737737
byte

content/java/english/com.aspose.slides/chartseriesgroup/_index.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Represents group of series.
3636
| [setFirstSliceAngle(int value)](#setFirstSliceAngle-int-) | Gets or sets the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees). |
3737
| [getDoughnutHoleSize()](#getDoughnutHoleSize--) | Specifies the size of the hole in a doughnut chart (can be between 0 and 90 percents of the size of the plot area.). |
3838
| [setDoughnutHoleSize(byte value)](#setDoughnutHoleSize-byte-) | Specifies the size of the hole in a doughnut chart (can be between 0 and 90 percents of the size of the plot area.). |
39-
| [getOverlap()](#getOverlap--) | Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). |
40-
| [setOverlap(byte value)](#setOverlap-byte-) | Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). |
39+
| [getOverlap()](#getOverlap--) | Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%). |
40+
| [setOverlap(byte value)](#setOverlap-byte-) | Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%). |
4141
| [getSecondPieSize()](#getSecondPieSize--) | Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents). |
4242
| [setSecondPieSize(int value)](#setSecondPieSize-int-) | Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents). |
4343
| [getBubbleSizeRepresentation()](#getBubbleSizeRepresentation--) | Specifies how the bubble size values are represented on the bubble chart. |
@@ -211,7 +211,24 @@ public final byte getOverlap()
211211
```
212212

213213

214-
Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). Read/write byte.
214+
Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%). - -100%: Maximum spacing (bars are completely separated). - 0%: Bars are placed side by side without overlap or spacing. - 100%: Maximum overlap (bars completely overlap each other). This property is read/write byte .
215+
216+
--------------------
217+
218+
> ```
219+
> The following example demonstrates how to set the overlap for a chart series group
220+
> and render the resulting chart on a form:
221+
>
222+
> Presentation pres = new Presentation();
223+
> try {
224+
> IChart chart = pres.getSlides().get_Item(0).getShapes().addChart(ChartType.ClusteredColumn, 10, 10, 600, 300);
225+
> IChartSeriesCollection series = chart.getChartData().getSeries();
226+
> series.get_Item(0).getParentSeriesGroup().setOverlap((byte)55); // Set overlap to 55%
227+
> pres.getSlides().get_Item(0).getImage(1, 1).save("chart.png");
228+
> } finally {
229+
> if (pres != null) pres.dispose();
230+
> }
231+
> ```
215232
216233
**Returns:**
217234
byte
@@ -221,7 +238,24 @@ public final void setOverlap(byte value)
221238
```
222239
223240
224-
Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). Read/write byte.
241+
Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%). - -100%: Maximum spacing (bars are completely separated). - 0%: Bars are placed side by side without overlap or spacing. - 100%: Maximum overlap (bars completely overlap each other). This property is read/write byte .
242+
243+
--------------------
244+
245+
> ```
246+
> The following example demonstrates how to set the overlap for a chart series group
247+
> and render the resulting chart on a form:
248+
>
249+
> Presentation pres = new Presentation();
250+
> try {
251+
> IChart chart = pres.getSlides().get_Item(0).getShapes().addChart(ChartType.ClusteredColumn, 10, 10, 600, 300);
252+
> IChartSeriesCollection series = chart.getChartData().getSeries();
253+
> series.get_Item(0).getParentSeriesGroup().setOverlap((byte)55); // Set overlap to 55%
254+
> pres.getSlides().get_Item(0).getImage(1, 1).save("chart.png");
255+
> } finally {
256+
> if (pres != null) pres.dispose();
257+
> }
258+
> ```
225259
226260
**Parameters:**
227261
| Parameter | Type | Description |

content/java/english/com.aspose.slides/documentproperties/_index.md

Lines changed: 165 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,20 @@ Represents properties of a presentation.
125125
| [setCustomPropertyValue(String name, double value)](#setCustomPropertyValue-java.lang.String-double-) | Sets a named double custom property. |
126126
| [clearCustomProperties()](#clearCustomProperties--) | Removes all custom properties. |
127127
| [clearBuiltInProperties()](#clearBuiltInProperties--) | Clears and sets default values for all builtIn properties. |
128+
| [getScaleCrop()](#getScaleCrop--) | Indicates the display mode of the document thumbnail. |
129+
| [setScaleCrop(boolean value)](#setScaleCrop-boolean-) | Indicates the display mode of the document thumbnail. |
130+
| [getLinksUpToDate()](#getLinksUpToDate--) | Indicates whether hyperlinks in a document are up-to-date. |
131+
| [setLinksUpToDate(boolean value)](#setLinksUpToDate-boolean-) | Indicates whether hyperlinks in a document are up-to-date. |
132+
| [getHyperlinksChanged()](#getHyperlinksChanged--) | Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. |
133+
| [setHyperlinksChanged(boolean value)](#setHyperlinksChanged-boolean-) | Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. |
134+
| [getSlides()](#getSlides--) | Returns the total number of slides in a presentation document. |
135+
| [getHiddenSlides()](#getHiddenSlides--) | Returns the number of hidden slides in a presentation document. |
136+
| [getNotes()](#getNotes--) | Returns the number of slides in a presentation containing notes. |
137+
| [getParagraphs()](#getParagraphs--) | Returns the total number of paragraphs found in a document if applicable. |
138+
| [getWords()](#getWords--) | Returns the total number of words contained in a document. |
139+
| [getMultimediaClips()](#getMultimediaClips--) | Returns the total number of sound or video clips that are present in the document. |
140+
| [getTitlesOfParts()](#getTitlesOfParts--) | Specifies the title of each document part. |
141+
| [getHeadingPairs()](#getHeadingPairs--) | Indicates the grouping of document parts and the number of parts in each group. |
128142
| [deepClone()](#deepClone--) | Clones current object |
129143
| [cloneT()](#cloneT--) | Clones current object |
130144
### DocumentProperties() {#DocumentProperties--}
@@ -667,7 +681,7 @@ Remove a custom property associated with a specified name.
667681
| name | java.lang.String | Name of a custom property to remove. |
668682
669683
**Returns:**
670-
boolean - Return true if a property was removed, false overwise.
684+
boolean - Return true if a property was removed, false otherwise.
671685
### containsCustomProperty(String name) {#containsCustomProperty-java.lang.String-}
672686
```
673687
public final boolean containsCustomProperty(String name)
@@ -682,7 +696,7 @@ Check presents of a custom property with a specified name.
682696
| name | java.lang.String | Name of a custom property to check. |
683697
684698
**Returns:**
685-
boolean - Return true if property exists, false overwise.
699+
boolean - Return true if property exists, false otherwise.
686700
### get_Item(String name) {#get-Item-java.lang.String-}
687701
```
688702
public final Object get_Item(String name)
@@ -904,6 +918,155 @@ public final void clearBuiltInProperties()
904918
905919
Clears and sets default values for all builtIn properties.
906920
921+
### getScaleCrop() {#getScaleCrop--}
922+
```
923+
public final boolean getScaleCrop()
924+
```
925+
926+
927+
Indicates the display mode of the document thumbnail. Set this element to **true** to enable scaling of the document thumbnail to the display. Set this element to **false** to enable cropping of the document thumbnail to show only sections that fits the display. Read/write boolean.
928+
929+
**Returns:**
930+
boolean
931+
### setScaleCrop(boolean value) {#setScaleCrop-boolean-}
932+
```
933+
public final void setScaleCrop(boolean value)
934+
```
935+
936+
937+
Indicates the display mode of the document thumbnail. Set this element to **true** to enable scaling of the document thumbnail to the display. Set this element to **false** to enable cropping of the document thumbnail to show only sections that fits the display. Read/write boolean.
938+
939+
**Parameters:**
940+
| Parameter | Type | Description |
941+
| --- | --- | --- |
942+
| value | boolean | |
943+
944+
### getLinksUpToDate() {#getLinksUpToDate--}
945+
```
946+
public final boolean getLinksUpToDate()
947+
```
948+
949+
950+
Indicates whether hyperlinks in a document are up-to-date. Set this element to **true** to indicate that hyperlinks are updated. Set this element to **false** to indicate that hyperlinks are outdated. Read/write boolean.
951+
952+
**Returns:**
953+
boolean
954+
### setLinksUpToDate(boolean value) {#setLinksUpToDate-boolean-}
955+
```
956+
public final void setLinksUpToDate(boolean value)
957+
```
958+
959+
960+
Indicates whether hyperlinks in a document are up-to-date. Set this element to **true** to indicate that hyperlinks are updated. Set this element to **false** to indicate that hyperlinks are outdated. Read/write boolean.
961+
962+
**Parameters:**
963+
| Parameter | Type | Description |
964+
| --- | --- | --- |
965+
| value | boolean | |
966+
967+
### getHyperlinksChanged() {#getHyperlinksChanged--}
968+
```
969+
public final boolean getHyperlinksChanged()
970+
```
971+
972+
973+
Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. The next producer to open this document shall update the hyperlink relationships with the new hyperlinks specified in this part. Read/write boolean.
974+
975+
**Returns:**
976+
boolean
977+
### setHyperlinksChanged(boolean value) {#setHyperlinksChanged-boolean-}
978+
```
979+
public final void setHyperlinksChanged(boolean value)
980+
```
981+
982+
983+
Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. The next producer to open this document shall update the hyperlink relationships with the new hyperlinks specified in this part. Read/write boolean.
984+
985+
**Parameters:**
986+
| Parameter | Type | Description |
987+
| --- | --- | --- |
988+
| value | boolean | |
989+
990+
### getSlides() {#getSlides--}
991+
```
992+
public final int getSlides()
993+
```
994+
995+
996+
Returns the total number of slides in a presentation document. Read-only int.
997+
998+
**Returns:**
999+
int
1000+
### getHiddenSlides() {#getHiddenSlides--}
1001+
```
1002+
public final int getHiddenSlides()
1003+
```
1004+
1005+
1006+
Returns the number of hidden slides in a presentation document. Read-only int.
1007+
1008+
**Returns:**
1009+
int
1010+
### getNotes() {#getNotes--}
1011+
```
1012+
public final int getNotes()
1013+
```
1014+
1015+
1016+
Returns the number of slides in a presentation containing notes. Read-only int.
1017+
1018+
**Returns:**
1019+
int
1020+
### getParagraphs() {#getParagraphs--}
1021+
```
1022+
public final int getParagraphs()
1023+
```
1024+
1025+
1026+
Returns the total number of paragraphs found in a document if applicable. Read-only int.
1027+
1028+
**Returns:**
1029+
int
1030+
### getWords() {#getWords--}
1031+
```
1032+
public final int getWords()
1033+
```
1034+
1035+
1036+
Returns the total number of words contained in a document. Read-only int.
1037+
1038+
**Returns:**
1039+
int
1040+
### getMultimediaClips() {#getMultimediaClips--}
1041+
```
1042+
public final int getMultimediaClips()
1043+
```
1044+
1045+
1046+
Returns the total number of sound or video clips that are present in the document. Read-only int.
1047+
1048+
**Returns:**
1049+
int
1050+
### getTitlesOfParts() {#getTitlesOfParts--}
1051+
```
1052+
public final String[] getTitlesOfParts()
1053+
```
1054+
1055+
1056+
Specifies the title of each document part. These parts are not document parts but conceptual representations of document sections. Read-only int.
1057+
1058+
**Returns:**
1059+
java.lang.String[]
1060+
### getHeadingPairs() {#getHeadingPairs--}
1061+
```
1062+
public final IHeadingPair[] getHeadingPairs()
1063+
```
1064+
1065+
1066+
Indicates the grouping of document parts and the number of parts in each group. Read-only IHeadingPair[].
1067+
1068+
**Returns:**
1069+
com.aspose.slides.IHeadingPair[]
9071070
### deepClone() {#deepClone--}
9081071
```
9091072
public final Object deepClone()
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: HeadingPair
3+
second_title: Aspose.Slides for Java API Reference
4+
description: Represents a Heading pair property of the document.
5+
type: docs
6+
url: /com.aspose.slides/headingpair/
7+
---
8+
**Inheritance:**
9+
java.lang.Object
10+
11+
**All Implemented Interfaces:**
12+
[com.aspose.slides.IHeadingPair](../../com.aspose.slides/iheadingpair)
13+
```
14+
public final class HeadingPair implements IHeadingPair
15+
```
16+
17+
Represents a 'Heading pair' property of the document. It indicates the group name of document parts and the number of parts in group.
18+
## Methods
19+
20+
| Method | Description |
21+
| --- | --- |
22+
| [getName()](#getName--) | Returns the group name of document parts. |
23+
| [getCount()](#getCount--) | Returns the number of parts in group. |
24+
### getName() {#getName--}
25+
```
26+
public final String getName()
27+
```
28+
29+
30+
Returns the group name of document parts. Read-only String.
31+
32+
**Returns:**
33+
java.lang.String
34+
### getCount() {#getCount--}
35+
```
36+
public final int getCount()
37+
```
38+
39+
40+
Returns the number of parts in group. Read-only int.
41+
42+
**Returns:**
43+
int

content/java/english/com.aspose.slides/ichartseries/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Represents a chart series.
7070
| [getGapDepth()](#getGapDepth--) | Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart. |
7171
| [isColorVaried()](#isColorVaried--) | Specifies that each data marker in the series has a different color. |
7272
| [hasSeriesLines()](#hasSeriesLines--) | Determines whether there are series lines for this series and kindred series. |
73-
| [getOverlap()](#getOverlap--) | Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). |
73+
| [getOverlap()](#getOverlap--) | Specifies how much bars and columns overlap on 2-D charts, as a percentage (from -100% to 100%). |
7474
| [getSecondPieSize()](#getSecondPieSize--) | Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents). |
7575
| [getPieSplitPosition()](#getPieSplitPosition--) | Specifies a value that shall be used to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart. |
7676
| [getPieSplitBy()](#getPieSplitBy--) | Specifies how to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart. |
@@ -710,11 +710,11 @@ public abstract byte getOverlap()
710710
```
711711

712712

713-
Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.Overlap read/write property for change value. Read-only byte.
713+
Specifies how much bars and columns overlap on 2-D charts, as a percentage (from -100% to 100%). This is the property not only of this series but of all series of parent series group. It is a projection of the appropriate property in the parent series group, and so this property is read-only. To change the value, use the ParentSeriesGroup.Overlap read/write property. Read-only byte .
714714

715715
--------------------
716716

717-
This is the projection of the property ParentSeriesGroup.Overlap.
717+
Overlap specifies the degree of overlap or spacing between bars and columns as a percentage of their width: - -100%: Maximum spacing (bars are completely separated). - 0%: Bars are placed side by side without overlap or spacing. - 100%: Maximum overlap (bars completely overlap each other). This is a projection of the property ParentSeriesGroup.Overlap.
718718

719719
**Returns:**
720720
byte

0 commit comments

Comments
 (0)