## Tcl9.0.3/Tk9.0.3 Documentation > Tk Commands > nsimage

### Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

  NAME
    nsimage — NSImage 級に基いたmacOSの為の Tk 影像型 A Tk image type for macOS based on the NSImage class.
  説明 DESCRIPTION
    image create nsimage ?name? ?option value ...?
  OPTIONS
    -source string
    -as type
    name
    file
    path
    filetype
    -width pixels
    -height pixels
    -radius pixels
    -ring pixels
    -alpha float
    -pressed boolean
    -template boolean
  SEE ALSO
  KEYWORDS

### NAME

nsimage — NSImage 級に基いたmacOSの為の Tk 影像型 A Tk image type for macOS based on the NSImage class.

### 説明 DESCRIPTION

nsimageはTk影像型として実装される｡ image命令は､型nsimageの映像を含む､ 全ての映像を生成､削除､問合せする｡ 利用できる､指示項目は､ nsimage型と下に記述する型に特化している｡ The nsimage is implemented as a Tk image type. The image command is used to create, delete, and query all images, including images of type nsimage. The options that are available are specific to the nsimage type and are described below.

nsimageを生成する命令: The command to create an nsimage:

image create nsimage ?name? ?option value ...?

新しいnsimageと､名前を伴う命令とを創生し､その名前を返す｡ creates a new nsimage and a command with the same name and returns its name.

### OPTIONS

Valid options are:

-source string

-source指示項目の値はNSimageを記述する文字列である｡この文字列を解釈実行する幾つかの方法があり､且つ､解釈実行は-as 指示項目の値によって定まる｡ この指示項目は以下の通りに要求される｡ The value of the -source option is a string describing an NSimage. There are several ways to interpret this string, and the interpretation is determined by the value of the -as option. This option is required.

-as type

-as指示項目には四つの値が可能であり､源資が如何に解釈されるかを指定する｡ 許容される値と､その意味は以下の通り: 　 There are four possible values for the -as option which specify how the source string should be interpreted. The allowed values and their meanings are:

name
  源資は系に提供されたNSImageに名付けられた名前として解釈される｡ これは-as指示項目が指定されない場合の無為設定である｡ The source should be interpreted as the name of a named NSImage provided by the system. This is the default if the -as option is not specified.

file
  源資は､NSImage級によって理解される書式の内の一つの中の映像ファイルへの経路と解釈される｡ The source should be interpreted as a path to an image file in one of the formats understood by the NSImage class.

path
  源資は､任意のファイルへの経路と解釈される｡ ファイルの型は調べられ､結果の映像は､その型のファイルの為の系アイコンになる｡ The source should be interpreted as a path to an arbitrary file. The type of the file will be examined and the resulting image will be the system icon for files of that type.

filetype
  源資は､特定のファイル型を特定する文字列と解釈される｡ それは､ファイル拡張子か､ アプル単一形式型識別子か､ HFSファイル系内の4文字OS型値か､かもしれない｡ The source is interpreted as a string identifying a particular file type. It may be a filename extension, an Apple Uniform Type Identifier or a 4-character OSType value as used in the HFS filesystem.

-width pixels

width 指示項目の値は､ns映像の巾を画素単位で指定する整数である｡ もし､巾が指定されないと､保存された映像の縦横比の通りに高さから算出される｡ もし､巾も高さも指定されないと､基本的なNSImageの巾と高さを使って､指定される｡ The value of the width option is an integer specifying the width in pixels of the nsimage. If the width is not specified it will be computed from the height so as to preserve the aspect ration. If neither width nor height are specified then the width and height of the underlying NSImage will be used.

-height pixels

height 指示項目の値は､ns映像の高さを画素単位で指定する整数である｡ もし､高さが指定されないと､保存された映像の縦横比の通りに高さから算出される｡ もし､巾も高さも指定されないと､基本的なNSImageの巾と高さを使って､指定される｡ The value of the height option is an integer specifying the height in pixels of the nsimage. If the height is not specified it will be computed from the height so as to preserve the aspect ration. If neither width nor height are specified then the width and height of the underlying NSImage will be used.

-radius pixels

radius 指示項目の値は､整数である｡ 非零であると､映像は､映像として同じ幅と高さを有し､角が丸く斬られる､ 但し､指定された円弧の半径を伴って､対角の隅が切取られる｡ The value of the radius option is an integer. If non-zero the image will be clipped to a rounded rectangle with the same width and height as the image, but with circular arcs of the specified radius cutting off the corners of the rectangle.

-ring pixels

ring 指示項目は整数である｡もし､非零であると､､ 系が選択した強調色を使用して映像の周りに描かれる､ 焦点円の厚さを指定する｡ 注意すべきは､これは小さな歪を創生し得る｡非正方映像の縦横比が微妙に変わる｡ The value of the ring option is an integer. If non-zero then it specifies the thickness of a focus ring which will be drawn around the image using the control accent color specified in the System Preferences. The image is resized to reduce its width and height by twice the thickness of the ring. Note that this may create a small amount of distortion. The aspect ration of a non-square image will change slightly.

-alpha float

alpha 指示項目の値は 0.0 と 1.0の間の浮動小数であり得る｡ このアルファ値はnsimageのそれぞれの画素に適用され､部分的に透明な映像を制作する｡無為設定値は 1.0であり､映像を不透明にする｡ The value of the alpha option should be a floating point number between 0.0 and 1.0. This alpha value will be applied to each pixel of the nsimage, producing a partially transparent image. The default value is 1.0, which makes the image opaque.

-pressed boolean

pressed 指示項目は論理値をとる｡もし､値が真値か 1 であると､ 映像は算術的に修正され､墨書様式では暗くされ､白抜様式では明るくされる｡ 無為設定は偽値である｡ 映像釦については､最初の映像は､圧縮映像が同じ映像の間は 偽値を使うべきだが､ pressed指示項目は真値に設定する｡　　　　　 The pressed option takes a boolean value. If the value is true or 1 then the image will be algorithmically modified to become darker in light mode or lighter in dark mode. The default is false. For an image button, the primary image should use the value false while the pressed image should be the same image but with the pressed option set to true.

-template boolean

template 指示項目は論理値をとる｡もし､値が真値か 1 であると､映像は雛形映像と印される｡それは､系は､墨書様式の場合は､ 算術的に映像を明るい色の映像に変換する｡ 算術が正しく働く為に､映像はアルファ値を伴う黒い画素のみで構成されてなければならない｡　　　　　　　　　 The template option takes a boolean value. If the value is true or 1 then the image will be marked as being a template image. This means that the system will algorithmically convert the image to a light colored image when in dark mode. For the algorithm to work correctly the image must consist only of black pixels with alpha values.

### SEE ALSO

image, options, photo

### KEYWORDS

height, image, types of images, width
Copyright © 2022 Marc Culler