get

グラフィックス オブジェクトのプロパティのクエリ

構文

get(h)

s = get(h)

v = get(h,propertyNames)

s = get(h,"default")

s = get(groot,"factory")

v = get(h,defaultTypeProperty)

v = get(groot,factoryTypeProperty)

説明

get(h) は、指定したグラフィックス オブジェクト h のプロパティおよびプロパティ値をコマンド ウィンドウに表示します。h は単一のオブジェクトでなければなりません。h が空 ([ ]) の場合、get は何もせず、警告やエラーを返しません。

s = get(h) は、指定したグラフィックス オブジェクト h のすべてのプロパティおよびプロパティ値を含む構造体を返します。h がオブジェクトのベクトルの場合、get は、h のすべてのオブジェクトのプロパティおよび値を返します。h が空 ([ ]) の場合、get は何もせず、警告やエラーを返しません。

v = get(h,propertyNames) は指定したグラフィックス オブジェクト h の指定したプロパティの値を返します。

• h が単一のオブジェクトであり、propertyNames が 1 つのプロパティを指定する string または文字ベクトルである場合、get は指定したプロパティの値を返します。h が単一のオブジェクトであり、propertyNames が 1 つの以上のプロパティを指定する cell 配列である場合、get は指定したプロパティの値を含む 1 行 n 列の cell 配列を返します。ここで、n は propertyNames のプロパティの数です。

• h がオブジェクトのベクトルの場合、get は、指定したプロパティの値を含む m 行 n 列の cell 配列を返します。ここで、m は h の要素数、n は propertyNames に含まれるプロパティの数です。

s = get(h,"default") は、指定したオブジェクトに対して定義されているすべての既定のプロパティ値を含む構造体を返します。

s = get(groot,"factory") は、グラフィックス ルート オブジェクト groot のすべてのユーザー設定可能なプロパティの出荷時設定値を含む構造体を返します。

v = get(h,defaultTypeProperty) は、指定したグラフィックス オブジェクト h の指定したプロパティおよびオブジェクト タイプの既定値を返します。defaultTypeProperty は、default という単語にオブジェクト タイプ (Figure など) とプロパティ名 (Color など) を連結し、引用符で囲んだものです。たとえば、v = get(groot,"defaultFigureColor") は、グラフィックス ルート オブジェクト groot の Figure オブジェクトの Color プロパティの既定値を返します。

v = get(groot,factoryTypeProperty) は、グラフィックス ルート オブジェクト groot の指定したプロパティおよびオブジェクト タイプの出荷時設定値を返します。factoryTypeProperty は、factory という単語にオブジェクト タイプ (Figure など) とプロパティ名 (Color など) を連結し、引用符で囲んだものです。たとえば、v = get(groot,"factoryFigureColor") は、Figure オブジェクトの Color プロパティの出荷時設定値を返します。

例

オブジェクトのすべてのプロパティ値のリスト

ライン プロットを作成して、Line オブジェクトを p として返します。オブジェクトのすべてのプロパティおよび現在の値をリストします。

p = plot(1:10);

get(p)

      AffectAutoLimits: on
    AlignVertexCenters: off
            Annotation: [1×1 matlab.graphics.eventdata.Annotation]
          BeingDeleted: off
            BusyAction: 'queue'
         ButtonDownFcn: ''
              Children: [0×0 GraphicsPlaceholder]
              Clipping: on
                 Color: [0.0660 0.4430 0.7450]
             ColorMode: 'auto'
           ContextMenu: [0×0 GraphicsPlaceholder]
             CreateFcn: ''
       DataTipTemplate: [1×1 matlab.graphics.datatip.DataTipTemplate]
             DeleteFcn: ''
           DisplayName: ''
      HandleVisibility: 'on'
               HitTest: on
         Interruptible: on
              LineJoin: 'round'
             LineStyle: '-'
         LineStyleMode: 'auto'
             LineWidth: 0.5000
                Marker: 'none'
       MarkerEdgeColor: 'auto'
       MarkerFaceColor: 'none'
         MarkerIndices: [1 2 3 4 5 6 7 8 9 10]
            MarkerMode: 'auto'
            MarkerSize: 6
                Parent: [1×1 Axes]
         PickableParts: 'visible'
              Selected: off
    SelectionHighlight: on
           SeriesIndex: 1
           SourceTable: [0×0 table]
                   Tag: ''
                  Type: 'line'
              UserData: []
               Visible: on
                 XData: [1 2 3 4 5 6 7 8 9 10]
             XDataMode: 'auto'
           XDataSource: ''
             XVariable: ''
                 YData: [1 2 3 4 5 6 7 8 9 10]
             YDataMode: 'manual'
           YDataSource: ''
             YVariable: ''
                 ZData: [1×0 double]
             ZDataMode: 'auto'
           ZDataSource: ''
             ZVariable: ''

オブジェクトの単一のプロパティ値の取得

ライン プロットを作成して、Line オブジェクトを p として返します。LineWidth プロパティの現在の値を取得します。

p = plot(1:10);

get(p,"LineWidth")

ans = 
0.5000

オブジェクトの複数のプロパティ値の取得

My App というタイトルの Figure を作成します。Figure の Name、Position、および Color プロパティの現在の値を取得します。

fig = uifigure("Name","My App");

props = {"Name","Position","Color"};
get(fig,props)

ans=1×3 cell array
    {'My App'}    {[348 367 583 437]}    {[0.9608 0.9608 0.9608]}

ルートのプロパティの既定値の取得

すべてのグラフィックス オブジェクトのルートに定義されている既定値を取得します。

get(groot,"default")

ans = struct with fields:
             defaultFigurePosition: [167 243 560 337.1852]
    defaultFigurePaperPositionMode: 'auto'
              defaultFigureVisible: off
              defaultFigureToolBar: 'none'
              defaultFigureMenuBar: 'none'
          defaultFigureWindowStyle: 'normal'

オブジェクトのプロパティの既定値の取得

赤のライン プロットを作成して、Line オブジェクトを p として返します。

p = plot(1:10,"Color","red");

p に対して定義されている Color プロパティの現在の値および既定値を取得します。

get(p,"Color")

ans = 1×3

     1     0     0

get(p,"defaultLineColor")

ans = 1×3

    0.1294    0.1294    0.1294

ルートのプロパティの出荷時設定値の取得

すべての Line オブジェクトのルートに定義されている MarkerSize プロパティの出荷時設定値を取得します。

get(groot,"factoryLineMarkerSize")

ans = 
6

入力引数

h — グラフィックス オブジェクト

単一のオブジェクト | オブジェクトのベクトル

グラフィックス オブジェクト。単一のオブジェクト、またはオブジェクトのベクトルとして指定します。

メモ

メモリ リークの原因となるため、関数 get は、Java^® オブジェクトに対して使用しないでください。詳細については、パブリック データおよびプライベート データへのアクセスを参照してください。

propertyNames — プロパティ名

string スカラー | 文字ベクトル | cell 配列

プロパティ名。string スカラー、文字ベクトル、または cell 配列として指定します。

defaultTypeProperty — 既定のプロパティ名

string スカラー | 文字ベクトル

既定のプロパティ名。string スカラーまたは文字ベクトルとして指定します。defaultTypeProperty は、単語 default にオブジェクト タイプ (Figure など) およびプロパティ名 (Color など) を連結して引用符で囲んだものです。

例: get(groot,"defaultFigureColor")

factoryTypeProperty — 出荷時のプロパティ名

string スカラー | 文字ベクトル

出荷時のプロパティ名。string スカラーまたは文字ベクトルとして指定します。factoryTypeProperty は、単語 factory にオブジェクト タイプ (Figure など) およびプロパティ名 (Color など) を連結して引用符で囲んだものです。

例: get(groot,"factoryFigureColor")

出力引数

s — プロパティの名前と値

構造体

プロパティの名前と値。構造体として返されます。構造体では、フィールド名はオブジェクトのプロパティ名であり、フィールド値はそれに対応するプロパティ値です。

v — プロパティ値

任意の値 | cell 配列

プロパティ値。任意のデータ型の単一の値または cell 配列として返されます。

バージョン履歴

R2006a より前に導入

参考

関数

• findobj | set | gcf | gca | gco

トピック

• グラフィックス オブジェクトのプロパティ
• 既定のプロパティ値