pyosbxl.chart.ChartTextBoxAlignment

class documentation

class ChartTextBoxAlignment:

View In Hierarchy

チャートのテキストボックスの配置に関するクラスです。

Method getAnchorAlignment テキストの配置位置を取得します。
Method getBottomMargin 下余白を取得します。
Method getColumnCount 段組みの数を取得します。
Method getColumnSpacing 段組みの間隔を取得します。
Method getLeftMargin 左余白を取得します。
Method getOrientation 文字列の方向を取得します。
Method getResizeShapeFitText テキストに合わせて図形のサイズを調整するかどうかを取得します。
Method getRightMargin 右余白を取得します。
Method getTextOveflow テキストを図形からはみ出して表示するかどうかを取得します。
Method getTopMargin 上余白を取得します。
Method getWrapText 図形内でテキストを折り返すかどうかを取得します。
Method setAlignment テキストの配置方法を設定します。
Method setBottomMargin 下余白を設定します。
Method setColumnCount 段組みの数を設定します。
Method setColumnSpacing 段組みの間隔を設定します。
Method setLeftMargin 左余白を設定します。
Method setRightMargin 右余白を設定します。
Method setTopMargin 上余白を設定します。
def getAnchorAlignment(self) -> enums.XlHVAlign:

テキストの配置位置を取得します。

Returns
XlHVAlignテキストの配置位置
def getBottomMargin(self) -> float:

下余白を取得します。

Returns
float下余白 単位は㎝です。
def getColumnCount(self) -> int:

段組みの数を取得します。

Returns
int段組みの数
def getColumnSpacing(self) -> float:

段組みの間隔を取得します。

Returns
float段組みの間隔 単位は㎝です。
def getLeftMargin(self) -> float:

左余白を取得します。

Returns
float左余白 単位は㎝です。
def getOrientation(self) -> enums.XlChartLabelOrientation:

文字列の方向を取得します。

Returns
XlChartLabelOrientation文字列の方向
def getResizeShapeFitText(self) -> bool:

テキストに合わせて図形のサイズを調整するかどうかを取得します。

Returns
booltrue: テキストに合わせて図形のサイズを調整する false:テキストに合わせて図形のサイズを調整しない
def getRightMargin(self) -> float:

右余白を取得します。

Returns
float右余白 単位は㎝です。
def getTextOveflow(self) -> bool:

テキストを図形からはみ出して表示するかどうかを取得します。

Returns
booltrue:テキストを図形からはみ出して表示する false:テキストを図形からはみ出して表示しない
def getTopMargin(self) -> float:

上余白を取得します。

Returns
float上余白 単位は㎝です。
def getWrapText(self) -> bool:

図形内でテキストを折り返すかどうかを取得します。

Returns
booltrue: 図形内でテキストを折り返す false: 図形内でテキストを折り返さない
def setAlignment(self, alignment: enums.XlHVAlign, orientation: enums.XlChartLabelOrientation, resizeShapeFitText: Optional[bool] = None, textOverFlow: Optional[bool] = None, wrapText: Optional[bool] = None, customAngle: Optional[int] = None):

テキストの配置方法を設定します。

配置位置と文字列の方向の値は関連があります。

文字列の方向が水平方向：配置位置で垂直方向の値を設定 文字列の方向が水平方向以外: 配置位置で水平方向の値を設定 となります。

無効なコンビネーションを設定すると、例外が返されます。

テキストの詳細項目を設定できない描画オブジェクトもあり、その場合設定できるのは、alignment および orientation のみとなります。

resizeShapeFitText以降のパラメータは任意ですが、指定する場合、全て指定してください。

Parameters
alignment:XlHVAlign配置位置
orientation:XlChartLabelOrientation文字列の方向
resizeShapeFitText:bool, optionaltrue: テキストに合わせて図形のサイズを調整する false: テキストに合わせて図形のサイズを調整しない
textOverFlow:bool, optionaltrue: テキストを図形からはみ出して表示する false: テキストを図形からはみ出して表示しない
wrapText:bool, optionaltrue: 図形内でテキストを折り返す false: 図形内でテキストを折り返さない
customAngle:int, optionalユーザー設定の角度(-90～90)
def setBottomMargin(self, margin: float):

下余白を設定します。

Parameters
margin:float下余白 単位は㎝です。
def setColumnCount(self, count: int):

段組みの数を設定します。

Parameters
count:int段組みの数
def setColumnSpacing(self, spacing: float):

段組みの間隔を設定します。

Parameters
spacing:float段組みの間隔 単位は㎝です。
def setLeftMargin(self, margin: float):

左余白を設定します。

Parameters
margin:float左余白 単位は㎝です。
def setRightMargin(self, margin: float):

右余白を設定します。

Parameters
margin:float右余白 単位は㎝です。
def setTopMargin(self, margin: float):

上余白を設定します。

Parameters
margin:float上余白 単位は㎝です。