15.3.3.2 Свойства Figure

Свойства объектов figure (см. figure):

Категории:

Внешний вид | Выполнение обратного вызова | Создание/удаление | Отображение | Взаимодействие с клавиатурой | Взаимодействие с мышью | Идентификация объекта | Положение объекта | Родительский объект/дочерние объекты | Печать/сохранение | Неиспользуемые

Внешний вид

alphamap: def. 64-by-1 double

Прозрачность объектов figure пока не реализована. alphamap не используется.

color: colorspec, def. [1 1 1]

Цвет фона figure. См. colorspec.

colormap: N-by-3 matrix, def. 64-by-3 double

Матрица, содержащая цветовую карту RGB для текущих осей.

graphicssmoothing: "off" | {"on"}

Использовать сглаживание для уменьшения заметности зубчатых линий.

name: string, def. ""

Имя, отображаемое в строке заголовка figure. Имя отображается справа от заголовка, заданного свойством numbertitle.

numbertitle: "off" | {"on"}

Отображать "Figure", а затем числовое значение дескриптора figure в строке заголовка figure.

Выполнение обратного вызова

busyaction: "cancel" | {"queue"}

Определяет, как Octave обрабатывает выполнение свойств обратного вызова этого объекта, если не может прервать выполнение обратного вызова другого объекта. Это имеет значение только тогда, когда для свойства interruptible текущего выполняющегося объекта обратного вызова задано значение "off". Свойство busyaction объекта прерывающего обратного вызова указывает, помещается ли прерывающий обратный вызов в очередь ("queue" (по умолчанию)) или отбрасывается ("cancel"). См. раздел Обратные вызовы.

interruptible: "off" | {"on"}

Указывает, могут ли функции обратного вызова этого объекта прерываться другими обратными вызовами. По умолчанию interruptible имеет значение "on", и обратные вызовы, использующие функции drawnow, figure, waitfor, getframe или pause, в конечном итоге прерываются. См. раздел Обратные вызовы.

Создание/удаление

beingdeleted: {"off"} | "on"

Свойство, указывающее, что функция начала удаление объекта. beingdeleted принимает значение true, пока объект не перестанет существовать.

closerequestfcn: string | function handle, def. "closereq"

Функция, выполняемая при удалении figure. См. функцию closereq.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

createfcn: string | function handle, def. [](0x0)

Функция обратного вызова, выполняемая сразу после создания figure. Функция задается с помощью свойства по умолчанию корневого объекта, например set (groot, "defaultfigurecreatefcn", 'disp ("figure created!")').

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

deletefcn: string | function handle, def. [](0x0)

Функция обратного вызова, выполняемая непосредственно перед удалением figure.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

Отображение

visible: "off" | {"on"}

Если visible имеет значение "off", figure не отображается на экране.

windowstate: "fullscreen" | "maximized" | "minimized" | {"normal"}

Настройка состояния окна для объектов figure пока не реализована. windowstate не используется.

windowstyle: "docked" | "modal" | {"normal"}

Стиль окна figure. Возможны следующие значения:

normal

Окно можно снять с переднего плана, и другие окна могут отображаться поверх него.

modal

Окно будет оставаться поверх всех обычных figure, пока его не закроют.

docked

Не реализовано.

Изменение режима видимой figure может привести к ее закрытию и повторному открытию.

Взаимодействие с клавиатурой

keypressfcn: string | function handle, def. [](0x0)

Функция обратного вызова, выполняемая при нажатии клавиши, когда figure находится в фокусе. Код нажатой клавиши можно получить с помощью второго аргумента функции — ’evt’.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

keyreleasefcn: string | function handle, def. [](0x0)

Вместе с keypressfcn — функции обратного вызова клавиатуры. Эти функции обратного вызова вызываются соответственно при нажатии и отпускании клавиши. Функции вызываются с двумя входными аргументами. Первый аргумент содержит дескриптор вызывающей figure. Второй аргумент содержит структуру события со следующими полями:

Character:

Значение ASCII клавиши

Key:

Значение клавиши в нижнем регистре

Modifier:

Массив ячеек со строками, обозначающими модификаторы, нажатые вместе с клавишей.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

windowkeypressfcn: string | function handle, def. [](0x0)

Функция, выполняемая при нажатии клавиши, когда figure находится в фокусе.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

windowkeyreleasefcn: string | function handle, def. [](0x0)

Функция, выполняемая при отпускании клавиши, когда figure находится в фокусе.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

Взаимодействие с мышью

buttondownfcn: string | function handle, def. [](0x0)

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

contextmenu: graphics handle, def. [](0x0)

Графический дескриптор объекта uicontextmenu, связанного в данный момент с этим объектом figure.

currentpoint (только для чтения): two-element vector, def. [0; 0]

Вектор 1 на 2, содержащий координаты точки, над которой находился указатель мыши в момент возникновения события мыши. Координаты X и Y заданы в единицах, определяемых свойством units figure; начало координат находится в нижнем левом углу области построения.

События, задающие currentpoint:

Нажата кнопка мыши

всегда

Отпущена кнопка мыши

только если определен обратный вызов figure windowbuttonupfcn

Указатель перемещен при нажатой кнопке мыши (перетаскивание)

только если определен обратный вызов figure windowbuttonmotionfcn

hittest: "off" | {"on"}

Указывает, обрабатывает ли figure события мыши или передает их родительским объектам. Если свойство включено, объект может реагировать на щелчки мыши, выполняя "buttondownfcn", отображая uicontextmenu и, в конечном итоге, становясь корневым "currentobject". Это свойство имеет значение только тогда, когда объект может принимать щелчки мыши; это определяется свойством "pickableparts". См. свойство pickableparts.

menubar: {"figure"} | "none"

Управляет отображением строки меню figure в верхней части окна.

pointer: {"arrow"} | "botl" | "botr" | "bottom" | "circle" | "cross" | "crosshair" | "custom" | "fleur" | "hand" | "ibeam" | "left" | "right" | "top" | "topl" | "topr" | "watch"

Имя формы указателя мыши, используемой на холсте figure. Если pointer имеет значение "custom", форма определяется свойством pointershapecdata.

pointer не действует, когда figure находится в режиме масштабирования, панорамирования или вращения. В этом случае Octave автоматически использует подходящую для режима форму указателя.

pointershapecdata: 16-by-16 or 32-by-32 Matrix, def. 16-by-16 double

Матрица m на m, определяющая пользовательский указатель. Каждый элемент задает пиксель; элемент (1,1) соответствует пикселю в верхнем левом углу. Значение 1 отображается черным цветом, значение 2 — белым, а все остальные значения отображаются как прозрачные.

pointershapehotspot: two-element vector, def. [1 1]

Только для пользовательских указателей: pointershapehotspot задает строку и столбец пикселя в pointershapecdata, используемого в качестве положения указателя.

resize: "off" | {"on"}

Управляет возможностью изменения размера figure перетаскиванием границ и углов окна мышью. Если resize имеет значение "off", взаимодействие с мышью отключено, но размер figure по-прежнему можно изменить, изменив ее свойство "position".

resizefcn: string | function handle, def. [](0x0)

Свойство resizefcn устарело. Вместо него используйте sizechangedfcn.

selected: {"off"} | "on"

Свойство указывает, выбрана ли эта figure.

selectionhighlight: "off" | {"on"}

Если selectionhighlight имеет значение "on", состояние выбора figure визуально выделяется.

selectiontype: "alt" | "extend" | {"normal"} | "open"

Тип выбора при последнем щелчке мышью.

selectiontype может принимать разные значения в зависимости от сочетания использованных кнопки мыши и модификатора клавиатуры:

normal:

Щелчок левой кнопкой.

alt:

Щелчок правой кнопкой или Ctrl+щелчок левой кнопкой.

extend:

Shift+щелчок левой кнопкой, щелчок средней кнопкой или одновременный щелчок левой и правой кнопками.

open:

Двойной щелчок левой кнопкой.

sizechangedfcn: string | function handle, def. [](0x0)

Обратный вызов, вызываемый при изменении размера окна figure.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

toolbar: {"auto"} | "figure" | "none"

Управляет отображением панели инструментов (в нижней части строки меню) и строки состояния. Если задано значение "auto", отображение определяется значением свойства "menubar".

windowbuttondownfcn: string | function handle, def. [](0x0)

См. свойство windowbuttonupfcn.

windowbuttonmotionfcn: string | function handle, def. [](0x0)

См. свойство windowbuttonupfcn.

windowbuttonupfcn: string | function handle, def. [](0x0)

Вместе с windowbuttondownfcn и windowbuttonmotionfcn — функции обратного вызова мыши. Эти функции обратного вызова вызываются соответственно при нажатии, перетаскивании или отпускании кнопки мыши. Во время выполнения этих функций обратного вызова свойство currentpoint содержит текущие координаты курсора.

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

windowscrollwheelfcn: string | function handle, def. [](0x0)

Функция, выполняемая при прокрутке колесика мыши над этой figure. Функция вызывается с двумя входными аргументами. Первый аргумент содержит дескриптор вызывающей figure. Второй аргумент содержит структуру события со следующими полями:

VerticalScrollCount:

Количество шагов колесика — обычно 1 при прокрутке вниз и -1 при прокрутке вверх.

VerticalScrollAmount:

Количество строк, на которое прокручивается содержимое за один шаг колесика. Это значение всегда равно 3.

EventName:

Имя события: "WindowScrollWheel".

Сведения о написании функций-обработчиков графических событий см. в разделе Обратные вызовы.

Идентификация объекта

currentaxes: graphics handle, def. [](0x0)

Дескриптор графического объекта текущих осей.

currentcharacter (только для чтения): def. ""

Отслеживание последней нажатой клавиши для объектов figure пока не реализовано. currentcharacter не используется.

currentobject (только для чтения): graphics handle, def. [](0x0)

Дескриптор последнего активного графического объекта в figure.

integerhandle: "off" | {"on"}

Назначить следующий наименьший неиспользуемый целочисленный номер figure.

nextplot: {"add"} | "new" | "replace" | "replacechildren"

Функции построения высокого уровня используют nextplot, чтобы определить, что делать с уже имеющимися в figure осями. См. функцию newplot.

number (только для чтения): double

Номер текущей figure.

tag: string, def. ""

Заданная пользователем строка для пометки графического объекта.

type (только для чтения): string

Имя класса графического объекта. type всегда имеет значение "figure".

userdata: Any Octave data, def. [](0x0)

Заданные пользователем данные, связанные с графическим объектом.

Положение объекта

dockcontrols: "off" | {"on"}

Интерактивное закрепление figure пока не реализовано для объектов figure. dockcontrols не используется.

innerposition: four-element vector, def. [300 200 560 420]

Свойство "innerposition" совпадает со свойством "position".

outerposition: four-element vector, def. [-1 -1 -1 -1]

Задает положение и размер figure, включая верхнюю строку меню и нижнюю строку состояния. Четыре элемента вектора — это координаты нижнего левого угла, ширина и высота figure. См. свойство units.

position: four-element vector, def. [300 200 560 420]

Задает положение и размер холста figure. Четыре элемента вектора — это координаты нижнего левого угла, ширина и высота figure. См. свойство units.

units: "centimeters" | "characters" | "inches" | "normalized" | {"pixels"} | "points"

Единицы измерения, используемые для вычисления свойств position и outerposition.

Родительский объект/дочерние объекты

children (только для чтения): vector of graphics handles, def. [](0x1)

Графические дескрипторы дочерних объектов figure.

handlevisibility: "callback" | "off" | {"on"}

Если handlevisibility имеет значение "off", дескриптор figure не отображается в свойстве "children" родительского объекта.

parent: graphics handle, def. 0

Дескриптор родительского графического объекта.

Печать/сохранение

filename: string, def. ""

Имя файла, используемое при сохранении figure с графиком.

inverthardcopy: "off" | {"on"}

При печати заменять цвет фона figure и осей на белый.

paperorientation: "landscape" | {"portrait"}

Значения свойств papersize и paperposition зависят от paperorientation. При переключении paperorientation между "portrait" и "landscape" горизонтальные и вертикальные значения papersize и paperposition меняются местами.

paperposition: four-element vector, def. [1.3422 3.3191 5.8156 4.3617]

Вектор [left bottom width height] задает положение и размер figure (в единицах paperunits) на печатной странице. Положение [left bottom] задает нижний левый угол figure на странице, а размер определяется свойством [width height]. Для выходных форматов, которые не отображаются непосредственно на бумаге, width и height задают размер изображения, а информация о положении игнорируется. Задание paperposition также принудительно устанавливает свойство paperpositionmode в значение "manual".

paperpositionmode: {"auto"} | "manual"

Если для paperpositionmode задано значение "auto", значение свойства paperposition вычисляется автоматически: размер напечатанной figure будет таким же, как у figure на экране, а сама она будет расположена по центру выходной страницы. Задание для paperpositionmode значения "auto" не изменяет значение свойства paperposition.

papersize: two-element vector, def. [8.5000 11.0000]

Вектор [width height] задает размер бумаги для печати. Если свойству papersize присвоено значение, не соответствующее ни одному из определенных значений papertypes и согласованное с настройкой paperorientation, свойству papertype принудительно присваивается значение "<custom>". Если для papersize задано значение, соответствующее поддерживаемому значению papertype и согласованное с paperorientation, значение papertype изменяется на соответствующее.

papertype: "<custom>" | "a" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "arch-a" | "arch-b" | "arch-c" | "arch-d" | "arch-e" | "b" | "b0" | "b1" | "b2" | "b3" | "b4" | "b5" | "c" | "d" | "e" | "tabloid" | "uslegal" | {"usletter"}

Название бумаги, используемой для печати. Задание papertype также изменяет papersize, сохраняя согласованность со свойством paperorientation.

paperunits: "centimeters" | {"inches"} | "normalized" | "points"

Единицы измерения, используемые для вычисления свойства paperposition. Преобразование физических единиц (например, "inches") зависит от свойства screenpixelsperinch корневого объекта.

renderer: {"opengl"} | "painters"

Механизм визуализации, используемый для печати, когда renderermode имеет значение "manual". Задание renderer также принудительно устанавливает свойство renderermode в значение "manual".

renderermode: {"auto"} | "manual"

Управляет тем, выбирается ли механизм визуализации для печати автоматически или задается свойством renderer. См. функцию print.

Неиспользуемые

clipping: "off" | {"on"}

clipping не используется.

pickableparts (только для чтения): "all" | "none" | {"visible"}

pickableparts не используется.