pyvista.Color

class Color(color: pyvista.ColorLike | None = None, opacity: int | float | str | None = None, default_color: pyvista.ColorLike | None = None, default_opacity: int | float | str = 255)

pyvista ライブラリで使用される異なる色表現間の変換を行うヘルパークラスです．

多くの pyvista メソッドは ColorLike パラメータを受け取ります．このヘルパークラスは，そのようなパラメータを，基本的な (VTK) メソッドで使用される必要な形式に変換するために使用されます．色名 ( str ) や 16 進文字列 ( str ) ， RGB(A) 配列 ( tuple , list または int や float ) の numpy.ndarray は ColorLike パラメータとみなされ，このクラスによって変換することが可能です．サポートされる色名の一覧は Color.name を参照してください．

パラメータ:

colorColorLike, optional

文字列，RGB配列，RGBA配列，16進数色文字列のいずれか．RGB(A)シーケンスは，0から1までのfloatか，0から255までのintとして提供されるべきです．16進数の色文字列には，オプションで '#' や 0x' という接頭辞をつけることができます．不透明度を指定しなかった場合は， default_opacity が使用されます．また， color に None を指定すると， default_color が代わりに使用されます．以下の例では，すべて '白' の色で表現しています．

• 'white'

• 'w'

• [1.0, 1.0, 1.0]

• [255, 255, 255, 255]

• '#FFFFFF'

opacityint | float | str, optional

表現された色の不透明度．与えられた color に関連するすべての不透明度を上書きします．許容される不透明度は，0 から 1 までの浮動小数点数，0 から 255 までの整数，または長さ 2（とオプションのプレフィックス長）の 16 進文字列です．以下の例では，すべて完全に不透明な色を表現しています．

• 1.0

• 255

• '#ff'

default_colorColorLike, optional

color が None の場合に使用されるデフォルトの色です． もしこの値が None であれば，デフォルトではグローバルテーマカラーを使用します． フォーマットは color と同じです．

default_opacityint | float | str, optional

表現された色のデフォルトの不透明度．color`` が不透明度を指定しない場合，および opacity が None の場合に使用されます．フォーマットは opacity と同じです．

備考

内部で使用される表現は，整数のRGBA配列（0～255の値）です．しかし，これは将来のリリースで変更される可能性があります．

対応色一覧は下表をご参照ください．

名称	16進数値	例
"aliceblue"	#F0F8FF
"antiquewhite"	#FAEBD7
"aquamarine"	#7FFFD4
"azure"	#F0FFFF
"beige"	#F5F5DC
"bisque"	#FFE4C4
"black" or "k"	#000000
"blanchedalmond"	#FFEBCD
"blue" または "b"	#0000FF
"blueviolet"	#8A2BE2
"brown"	#654321
"burlywood"	#DEB887
"cadetblue"	#5F9EA0
"chartreuse"	#7FFF00
"chocolate"	#D2691E
"coral"	#FF7F50
"cornflowerblue"	#6495ED
"cornsilk"	#FFF8DC
"crimson"	#DC143C
"cyan" または "c" または "aqua"	#00FFFF
"darkblue"	#00008B
"darkcyan"	#008B8B
"darkgoldenrod"	#B8860B
"darkgray" または "darkgrey"	#A9A9A9
"darkgreen"	#006400
"darkkhaki"	#BDB76B
"darkmagenta"	#8B008B
"darkolivegreen"	#556B2F
"darkorange"	#FF8C00
"darkorchid"	#9932CC
"darkred"	#8B0000
"darksalmon"	#E9967A
"darkseagreen"	#8FBC8F
"darkslateblue"	#483D8B
"darkslategray" または "darkslategrey"	#2F4F4F
"darkturquoise"	#00CED1
"darkviolet"	#9400D3
"deeppink"	#FF1493
"deepskyblue"	#00BFFF
"dimgray" または "dimgrey"	#696969
"dodgerblue"	#1E90FF
"firebrick"	#B22222
"floralwhite"	#FFFAF0
"forestgreen"	#228B22
"gainsboro"	#DCDCDC
"ghostwhite"	#F8F8FF
"gold"	#FFD700
"goldenrod"	#DAA520
"gray" または "grey"	#808080
"green" または "g"	#008000
"greenyellow"	#ADFF2F
"honeydew"	#F0FFF0
"hotpink"	#FF69B4
"indianred"	#CD5C5C
"indigo"	#4B0082
"ivory"	#FFFFF0
"khaki"	#F0E68C
"lavender"	#E6E6FA
"lavenderblush"	#FFF0F5
"lawngreen"	#7CFC00
"lemonchiffon"	#FFFACD
"lightblue"	#ADD8E6
"lightcoral"	#F08080
"lightcyan"	#E0FFFF
"lightgoldenrodyellow"	#FAFAD2
"lightgray" または "lightgrey"	#D3D3D3
"lightgreen"	#90EE90
"lightpink"	#FFB6C1
"lightsalmon"	#FFA07A
"lightseagreen"	#20B2AA
"lightskyblue"	#87CEFA
"lightslategray" または "lightslategrey"	#778899
"lightsteelblue"	#B0C4DE
"lightyellow"	#FFFFE0
"lime"	#00FF00
"limegreen"	#32CD32
"linen"	#FAF0E6
"magenta" または "m" または "fuchsia"	#FF00FF
"maroon"	#800000
"mediumaquamarine"	#66CDAA
"mediumblue"	#0000CD
"mediumorchid"	#BA55D3
"mediumpurple"	#9370DB
"mediumseagreen"	#3CB371
"mediumslateblue"	#7B68EE
"mediumspringgreen"	#00FA9A
"mediumturquoise"	#48D1CC
"mediumvioletred"	#C71585
"midnightblue"	#191970
"mintcream"	#F5FFFA
"mistyrose"	#FFE4E1
"moccasin"	#FFE4B5
"navajowhite"	#FFDEAD
"navy"	#000080
"oldlace"	#FDF5E6
"olive"	#808000
"olivedrab"	#6B8E23
"orange"	#FFA500
"orangered"	#FF4500
"orchid"	#DA70D6
"palegoldenrod"	#EEE8AA
"palegreen"	#98FB98
"paleturquoise"	#AFEEEE
"palevioletred"	#DB7093
"papayawhip"	#FFEFD5
"paraview_background" または "pv" または "paraview"	#52576e
"peachpuff"	#FFDAB9
"peru"	#CD853F
"pink"	#FFC0CB
"plum"	#DDA0DD
"powderblue"	#B0E0E6
"purple"	#800080
"raw_sienna"	#965434
"rebeccapurple"	#663399
"red" または "r"	#FF0000
"rosybrown"	#BC8F8F
"royalblue"	#4169E1
"saddlebrown"	#8B4513
"salmon"	#FA8072
"sandybrown"	#F4A460
"seagreen"	#2E8B57
"seashell"	#FFF5EE
"sienna"	#A0522D
"silver"	#C0C0C0
"skyblue"	#87CEEB
"slateblue"	#6A5ACD
"slategray" または "slategrey"	#708090
"snow"	#FFFAFA
"springgreen"	#00FF7F
"steelblue"	#4682B4
"tan"	#D2B48C
"teal"	#008080
"thistle"	#D8BFD8
"tomato"	#FF6347
"turquoise"	#40E0D0
"violet"	#EE82EE
"wheat"	#F5DEB3
"white" または "w"	#FFFFFF
"whitesmoke"	#F5F5F5
"yellow" または "y"	#FFFF00
"yellowgreen"	#9ACD32
"tab:blue"	#1f77b4
"tab:orange"	#ff7f0e
"tab:green"	#2ca02c
"tab:red"	#d62728
"tab:purple"	#9467bd
"tab:brown"	#8c564b
"tab:pink"	#e377c2
"tab:gray"	#7f7f7f
"tab:olive"	#bcbd22
"tab:cyan"	#17becf

例

色名，float RGBA 列，integer RGBA 列，RGBA 16 進文字列を使用して，透明な緑色を作成します．

>>> import pyvista as pv
>>> pv.Color("green", opacity=0.5)
Color(name='green', hex='#00800080', opacity=128)
>>> pv.Color([0.0, 0.5, 0.0, 0.5])
Color(name='green', hex='#00800080', opacity=128)
>>> pv.Color([0, 128, 0, 128])
Color(name='green', hex='#00800080', opacity=128)
>>> pv.Color("#00800080")
Color(name='green', hex='#00800080', opacity=128)

メソッド

Color.convert_color_channel(val)	与えられた色チャンネルの値を整数表現に変換します．
Color.from_dict(dict_)	JSONデシリアライズのために辞書から構築します．
Color.linear_to_srgb()	リニアカラー値からsRGBカラー値へ変換します．
Color.srgb_to_linear()	リニアカラー値からsRGBカラー値へ変換します．
Color.strip_hex_prefix(h)	16進文字列から '#' または 0x' という接頭辞を取り除きます．
Color.to_dict()	JSONシリアライズのために辞書に変換します．

アトリビュート

Color.float_rgb	色の値を RGB float のタプルとして返します．
Color.float_rgba	色の値を RGBA float のタプルとして返します．
Color.hex_rgb	色の値をRGBの16進数で返します．
Color.hex_rgba	色の値をRGBAの16進数で返します．
Color.int_rgb	色の値を RGB integer のタプルとして返します．
Color.int_rgba	色の値を RGBA integer のタプルとして返します．
Color.name	色名を返します．
Color.opacity	この色の不透明度を (0-255) の範囲で返します．
Color.vtk_c3ub	色の値をVTK Color3ubのインスタンスとして返します．