PivotFieldGroupOptions
Inheritance: java.lang.Object
public class PivotFieldGroupOptions
Options for pivot field grouping settings.
Constructors
| Constructor | Description |
|---|---|
| PivotFieldGroupOptions() |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getClass() | |
| getEndDate() | Gets the end value of the grouping range. |
| getEndNumber() | Gets the end value of the grouping range. |
| getGroupType() | Gets the grouping type for pivot field. |
| getGroupTypes() | Gets the grouping type for pivot field. |
| getInterval() | Gets the interval size for each group. |
| getNewPivotField() | Gets a value indicating whether new pivot fields should be created after grouping. |
| getStartDate() | Gets the start value of the grouping range. |
| getStartNumber() | Gets the start value of the grouping range. |
| hashCode() | |
| isAutoEnd() | Gets a value indicating whether the end value is automatically determined. |
| isAutoStart() | Gets a value indicating whether the start value is automatically determined. |
| notify() | |
| notifyAll() | |
| setAutoEnd(boolean value) | Sets a value indicating whether the end value is automatically determined. |
| setAutoStart(boolean value) | Sets a value indicating whether the start value is automatically determined. |
| setEndDate(DateTime value) | Sets the end value of the grouping range. |
| setEndNumber(double value) | Sets the end value of the grouping range. |
| setGroupType(int value) | Sets the grouping type for pivot field. |
| setGroupTypes(int[] value) | Sets the grouping type for pivot field. |
| setInterval(double value) | Sets the interval size for each group. |
| setNewPivotField(boolean value) | Sets a value indicating whether new pivot fields should be created after grouping. |
| setStartDate(DateTime value) | Sets the start value of the grouping range. |
| setStartNumber(double value) | Sets the start value of the grouping range. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
PivotFieldGroupOptions()
public PivotFieldGroupOptions()
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getEndDate()
public DateTime getEndDate()
Gets the end value of the grouping range.
Returns: DateTime
getEndNumber()
public double getEndNumber()
Gets the end value of the grouping range.
Returns: double
getGroupType()
public int getGroupType()
Gets the grouping type for pivot field. Only for grouping date time pivot field.
See PivotGroupByType.
Example
// Group by year and month together
PivotFieldGroupOptions opts = new PivotFieldGroupOptions();
opts.setGroupType(PivotGroupByType.YEARS | PivotGroupByType.MONTHS);
Returns: int
getGroupTypes()
public int[] getGroupTypes()
Gets the grouping type for pivot field.
See PivotGroupByType.
Remarks
The order in this property will be ignored. When specifying multiple group types, base group fields will be inserted in ascending order and show group field to row/column region in descending order (Years \u922b?Quarters \u922b?Months \u922b?Days \u922b?Hours \u922b?Minutes \u922b?Seconds).
Returns: int[]
getInterval()
public double getInterval()
Gets the interval size for each group.
Remarks
Only for number and days group.
Returns: double
getNewPivotField()
public boolean getNewPivotField()
Gets a value indicating whether new pivot fields should be created after grouping.
Remarks
If not explicitly set, the default value is false for numeric grouping and true for date-time grouping. Only works for the first new group pivot field of the base field.
Returns: boolean
getStartDate()
public DateTime getStartDate()
Gets the start value of the grouping range.
Returns: DateTime
getStartNumber()
public double getStartNumber()
Gets the start value of the grouping range.
Returns: double
hashCode()
public native int hashCode()
Returns: int
isAutoEnd()
public boolean isAutoEnd()
Gets a value indicating whether the end value is automatically determined.
Remarks
If getEndNumber() or getEndDate() is set, this property will be false.
Returns: boolean
isAutoStart()
public boolean isAutoStart()
Gets a value indicating whether the start value is automatically determined.
Remarks
If getStartNumber() or getStartDate() is set, this property will be false.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAutoEnd(boolean value)
public void setAutoEnd(boolean value)
Sets a value indicating whether the end value is automatically determined.
Remarks
If getEndNumber() or getEndDate() is set, this property will be false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setAutoStart(boolean value)
public void setAutoStart(boolean value)
Sets a value indicating whether the start value is automatically determined.
Remarks
If getStartNumber() or getStartDate() is set, this property will be false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setEndDate(DateTime value)
public void setEndDate(DateTime value)
Sets the end value of the grouping range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setEndNumber(double value)
public void setEndNumber(double value)
Sets the end value of the grouping range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setGroupType(int value)
public void setGroupType(int value)
Sets the grouping type for pivot field. Only for grouping date time pivot field.
See PivotGroupByType.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setGroupTypes(int[] value)
public void setGroupTypes(int[] value)
Sets the grouping type for pivot field.
See PivotGroupByType.
Remarks
The order in this property will be ignored. When specifying multiple group types, base group fields will be inserted in ascending order and show group field to row/column region in descending order (Years \u922b?Quarters \u922b?Months \u922b?Days \u922b?Hours \u922b?Minutes \u922b?Seconds).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int[] |
setInterval(double value)
public void setInterval(double value)
Sets the interval size for each group.
Remarks
Only for number and days group.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setNewPivotField(boolean value)
public void setNewPivotField(boolean value)
Sets a value indicating whether new pivot fields should be created after grouping.
Remarks
If not explicitly set, the default value is false for numeric grouping and true for date-time grouping. Only works for the first new group pivot field of the base field.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setStartDate(DateTime value)
public void setStartDate(DateTime value)
Sets the start value of the grouping range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setStartNumber(double value)
public void setStartNumber(double value)
Sets the start value of the grouping range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |
