pyosbxl.chart.DataLabel

class documentation

class DataLabel:

View In Hierarchy

チャートのデータラベルを取り扱うクラスです。

Method getAutoLayout 自動レイアウトが適用されているか取得します。
Method getAutoText 自動テキストが設定されているかどうかを取得します。
Method getBorderFormat オブジェクトの淵の描画クラスを取得します。
Method getCellRange データラベルに設定されたセル範囲を取得します。
Method getFillFormat オブジェクトの塗りつぶしの描画クラスを取得します。
Method getGlowFormat オブジェクトの光彩の描画クラスを取得します。
Method getLabelCallout オブジェクトの吹き出しを取得します。
Method getNumberFormat オブジェクトの書式を取得します。
Method getNumberFormatLinked 値の書式が、ワークシートにリンクされているかどうかを取得します。
Method getPosition データラベルの配置場所を取得します。
Method getSeparator オブジェクトの区切り文字を取得します。
Method getShadow 影付きが設定されているかどうかを取得します。
Method getShadowFormat オブジェクトの影つけの描画クラスを取得します。
Method getShowBubbleSize バブルサイズが表示設定されているかどうかを取得します。
Method getShowCategoryName カテゴリ名が表示設定されているかどうかを取得します。
Method getShowLeaderLines 導線表示が表示設定されているかどうかを取得します。
Method getShowLegendKey 凡例キーが表示設定されているかどうかを取得します。
Method getShowPercentage パーセント表示が表示設定されているかどうかを取得します。
Method getShowSeriesName シリーズ名が表示設定されているかどうかを取得します。
Method getShowValue 値が表示設定されているかどうかを取得します。
Method getSoftEdgeFormat オブジェクトのぼかしの描画クラスを取得します。
Method getText データラベルに設定された値を取得します。
Method getTextBoxAlignment オブジェクトのテキストボックスのレイアウトクラスを取得します。
Method getTextFillFormat オブジェクトのテキストの塗りつぶしの描画クラスを取得します。
Method getTextFont オブジェクトのテキストのチャートフォントクラスを取得します。
Method getTextGlowFormat オブジェクトのテキストの光彩の描画クラスを取得します。
Method getTextLineFormat オブジェクトのテキストの線の描画クラスを取得します。
Method getTextReflectionFormat オブジェクトのテキストの反射の描画クラスを取得します。
Method getTextShadowFormat オブジェクトのテキストの影付きの描画クラスを取得します。
Method getThreeDFormat オブジェクトの3D表示の描画クラスを取得します。
Method setAutoLayout 自動レイアウトを適用します。
Method setAutoText データラベルに自動テキスト設定を適用します。(設定不可能なチャート形式の場合、例外を取得します)
Method setCellRange データラベルにセル範囲を設定します。A1C1形式となります。(設定不可能なチャート形式の場合、例外を取得します)
Method setCustomLayout カスタムレイアウトを適用します。
Method setLabelCallout オブジェクトの吹き出しを設定します。
Method setNumberFormat 値の書式表示の表示設定の有無を設定します。
Method setNumberFormatLinked 書式のワークシートのリンクの有無を設定します。
Method setPosition オブジェクトのレイアウトを設定します。
Method setSeparator オブジェクトの区切り文字を設定します。
Method setShadow 影付きの表示設定の有無を設定します。
Method setShowBubbleSize バブルサイズの表示設定の有無を設定します。
Method setShowCategoryName カテゴリ名の表示設定の有無を設定します。
Method setShowLeaderLines 導線の表示設定の有無を設定します。
Method setShowLegendKey 凡例キーの表示設定の有無を設定します。
Method setShowPercentage パーセントの表示設定の有無を設定します。
Method setShowSeriesName シリーズ名の表示設定の有無を設定します。
Method setShowValue 値の表示設定の有無を設定します。
Method setText データラベルに値を設定します。(設定不可能なチャート形式の場合、例外を取得します)
def getAutoLayout(self) -> bool:

自動レイアウトが適用されているか取得します。

Returns
booltrue: 自動レイアウト false: カスタムレイアウト
def getAutoText(self) -> bool:

自動テキストが設定されているかどうかを取得します。

Returns
booltrue:自動テキストが設定されている false:自動テキストが設定されていない
def getBorderFormat(self) -> ChartLineFormat:

オブジェクトの淵の描画クラスを取得します。

Returns
ChartLineFormatオブジェクトの淵の描画クラス
def getCellRange(self) -> str:

データラベルに設定されたセル範囲を取得します。

Returns
strセル範囲(A1C1)
def getFillFormat(self) -> ChartFillFormat:

オブジェクトの塗りつぶしの描画クラスを取得します。

Returns
ChartFillFormatオブジェクトの塗りつぶしの描画クラス
def getGlowFormat(self) -> ChartGlowFormat:

オブジェクトの光彩の描画クラスを取得します。

Returns
ChartGlowFormatオブジェクトの光彩の描画クラス
def getLabelCallout(self) -> enums.XlLabelCallout:

オブジェクトの吹き出しを取得します。

Returns
XlLabelCalloutオブジェクトの吹き出し
def getNumberFormat(self) -> str:

オブジェクトの書式を取得します。

Returns
strオブジェクトの書式
def getNumberFormatLinked(self) -> bool:

値の書式が、ワークシートにリンクされているかどうかを取得します。

Returns
booltrue:書式がワークシートにリンクされている false:書式がワークシートにリンクされていない
def getPosition(self) -> enums.XlDataLabelPosition:

データラベルの配置場所を取得します。

Returns
XlDataLabelPositionデータラベルの配置場所
def getSeparator(self) -> str:

オブジェクトの区切り文字を取得します。

Returns
strオブジェクトの区切り文字
def getShadow(self) -> bool:

影付きが設定されているかどうかを取得します。

Returns
booltrue:影付きが設定されている false:影付きが設定されていない
def getShadowFormat(self) -> ChartShadowFormat:

オブジェクトの影つけの描画クラスを取得します。

Returns
ChartShadowFormatオブジェクトの影つけの描画クラス
def getShowBubbleSize(self) -> bool:

バブルサイズが表示設定されているかどうかを取得します。

Returns
booltrue:バブルサイズが設定されている false:バブルサイズが設定されていない
def getShowCategoryName(self) -> bool:

カテゴリ名が表示設定されているかどうかを取得します。

Returns
booltrue:カテゴリ名が設定されている false:カテゴリ名が設定されていない
def getShowLeaderLines(self) -> bool:

導線表示が表示設定されているかどうかを取得します。

Returns
booltrue:導線表示されている false:導線表示されていない
def getShowLegendKey(self) -> bool:

凡例キーが表示設定されているかどうかを取得します。

Returns
booltrue:凡例キーが設定されている false:凡例キーが設定されていない
def getShowPercentage(self) -> bool:

パーセント表示が表示設定されているかどうかを取得します。

Returns
booltrue:パーセント表示されている false:パーセント表示されていない
def getShowSeriesName(self) -> bool:

シリーズ名が表示設定されているかどうかを取得します。

Returns
booltrue:シリーズ名が表示されている false:シリーズ名が表示されていない
def getShowValue(self) -> bool:

値が表示設定されているかどうかを取得します。

Returns
booltrue:値が表示されている false:値が表示されていない
def getSoftEdgeFormat(self) -> ChartSoftEdgeFormat:

オブジェクトのぼかしの描画クラスを取得します。

Returns
ChartSoftEdgeFormatオブジェクトのぼかしの描画クラス
def getText(self) -> str:

データラベルに設定された値を取得します。

Returns
str値
def getTextBoxAlignment(self) -> ChartTextBoxAlignment:

オブジェクトのテキストボックスのレイアウトクラスを取得します。

Returns
ChartTextBoxAlignmentオブジェクトのテキストボックスのレイアウトクラス
def getTextFillFormat(self) -> ChartTextFillFormat:

オブジェクトのテキストの塗りつぶしの描画クラスを取得します。

Returns
ChartTextFillFormatオブジェクトのテキストの塗りつぶしの描画クラス
def getTextFont(self, start: Optional[int] = None, length: Optional[int] = None) -> ChartFont:

オブジェクトのテキストのチャートフォントクラスを取得します。

start,lengthを指定しない場合、全範囲となります。

Parameters
start:int, optional開始文字位置 (1から始まります)
length:int, optional文字数
Returns
ChartFontオブジェクトのテキストのチャートフォントクラス
def getTextGlowFormat(self) -> ChartTextGlowFormat:

オブジェクトのテキストの光彩の描画クラスを取得します。

Returns
ChartTextGlowFormatオブジェクトのテキストの光彩の描画クラス
def getTextLineFormat(self) -> ChartTextLineFormat:

オブジェクトのテキストの線の描画クラスを取得します。

Returns
ChartTextLineFormatオブジェクトのテキストの線の描画クラス
def getTextReflectionFormat(self) -> ChartTextReflectionFormat:

オブジェクトのテキストの反射の描画クラスを取得します。

Returns
ChartTextReflectionFormatオブジェクトのテキストの反射の描画クラス
def getTextShadowFormat(self) -> ChartTextShadowFormat:

オブジェクトのテキストの影付きの描画クラスを取得します。

Returns
ChartTextShadowFormatオブジェクトのテキストの影付きの描画クラス
def getThreeDFormat(self) -> ChartThreeDFormat:

オブジェクトの3D表示の描画クラスを取得します。

Returns
ChartThreeDFormatオブジェクトの3D表示の描画クラス
def setAutoLayout(self):

自動レイアウトを適用します。

def setAutoText(self):

データラベルに自動テキスト設定を適用します。(設定不可能なチャート形式の場合、例外を取得します)

def setCellRange(self, A1C1: str):

データラベルにセル範囲を設定します。A1C1形式となります。(設定不可能なチャート形式の場合、例外を取得します)

Parameters
A1C1:strセル範囲(A1C1)
def setCustomLayout(self, left: float, top: float, height: float, width: float):

カスタムレイアウトを適用します。

このメソッドのleft,top は、デフォルトの起点から相対値（ポイント単位）で、マイナス値を許容します。

Parameters
left:float左位置(現在の位置との差分)
top:float上位置(現在の位置との差分)
height:float高さ
width:float幅
def setLabelCallout(self, type: enums.XlLabelCallout):

オブジェクトの吹き出しを設定します。

Parameters
type:XlLabelCalloutオブジェクトの吹き出し
def setNumberFormat(self, format: str):

値の書式表示の表示設定の有無を設定します。

Parameters
format:str値の書式
def setNumberFormatLinked(self, apply: bool):

書式のワークシートのリンクの有無を設定します。

Parameters
apply:booltrue:書式のワークシートのリンクを設定する false:書式のワークシートのリンクを設定しない
def setPosition(self, position: enums.XlDataLabelPosition):

オブジェクトのレイアウトを設定します。

Parameters
position:XlDataLabelPositionオブジェクトのレイアウト
def setSeparator(self, separator: str):

オブジェクトの区切り文字を設定します。

Parameters
separator:strオブジェクトの区切り文字
def setShadow(self, apply: bool):

影付きの表示設定の有無を設定します。

Parameters
apply:booltrue:影付きの表示設定する false:影付きの表示設定しない
def setShowBubbleSize(self, apply: bool):

バブルサイズの表示設定の有無を設定します。

Parameters
apply:booltrue:バブルサイズを表示する false:バブルサイズを表示しない
def setShowCategoryName(self, apply: bool):

カテゴリ名の表示設定の有無を設定します。

Parameters
apply:booltrue:カテゴリ名を表示する false:カテゴリ名を表示しない
def setShowLeaderLines(self, apply: bool):

導線の表示設定の有無を設定します。

Parameters
apply:booltrue:導線を表示する false:導線を表示しない
def setShowLegendKey(self, apply: bool):

凡例キーの表示設定の有無を設定します。

Parameters
apply:booltrue:凡例キーを表示する false:凡例キーを表示しない
def setShowPercentage(self, apply: bool):

パーセントの表示設定の有無を設定します。

Parameters
apply:booltrue:パーセントを表示する false:パーセントを表示しない
def setShowSeriesName(self, apply: bool):

シリーズ名の表示設定の有無を設定します。

Parameters
apply:booltrue:シリーズ名を表示する false:シリーズ名を表示しない
def setShowValue(self, apply: bool):

値の表示設定の有無を設定します。

Parameters
apply:booltrue:値を表示する false:値を表示しない
def setText(self, text: str):

データラベルに値を設定します。(設定不可能なチャート形式の場合、例外を取得します)

Parameters
text:str値