15.3.3.2 Свойства Figure

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

alphamap: def. 64×1 double

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

beingdeleted: {"off"} | "on"

busyaction: "cancel" | {"queue"}

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

buttondownfcn: строка | дескриптор функции, def. [](0x0)

Дополнительная информация о написании функций слушателей графики находится в разделе Callbacks.

children (только для чтения): вектор графических дескрипторов, def. [](0x1)

Графические дескрипторы дочерних элементов figure.

clipping: "off" | {"on"}

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

closerequestfcn: строка | дескриптор функции, def. "closereq"

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

Дополнительная информация о написании функций слушателей графики находится в разделе Callbacks.

color: цветовое задание, def. [1 1 1]

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

colormap: матрица N×3, def. 64×3 double

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

createfcn: строка | дескриптор функции, def. [](0x0)

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

Дополнительная информация о написании функций слушателей графики находится в разделе Callbacks.

currentaxes: графический дескриптор, def. [](0x0)

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

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

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

currentobject (только для чтения): графический дескриптор, def. [](0x0)

currentpoint (только для чтения): двухэлементный вектор, def. [0; 0]

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

События, которые устанавливают currentpoint,

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

всегда

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

только если функция обратного вызова figure windowbuttonupfcn определена

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

только если функция обратного вызова figure windowbuttonmotionfcn определена

deletefcn: строка | дескриптор функции, def. [](0x0)

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

Дополнительная информация о написании функций слушателей графики находится в разделе Callbacks.

dockcontrols: {"off"} | "on"

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

filename: строка, def. ""

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

graphicssmoothing: "off" | {"on"}

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

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

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

hittest: "off" | {"on"}

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

integerhandle: "off" | {"on"}

Назначает следующее доступное целое число в качестве номера Figure.

interruptible: "off" | {"on"}

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

inverthardcopy: "off" | {"on"}

Заменяет цвет фона figure и области графики белым при печати.

keypressfcn: строка | дескриптор функции, def. [](0x0)

Функция обратного вызова, выполняемая при нажатии клавиши, когда figure имеет фокус. Фактическую нажатую клавишу можно получить, используя второй аргумент «evt» функции. Дополнительную информацию о написании функций слушателей графики см. в разделе Callbacks.

keyreleasefcn: строка | дескриптор функции, def. [](0x0)

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

Character:

ASCII-значение клавиши

Key:

Маленькие буквы клавиши

Modifier:

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

Дополнительную информацию о написании функций слушателей графики см. в разделе Callbacks.

menubar: {"figure"} | "none"

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

name: строка, def. ""

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

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

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

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

numbertitle: "off" | {"on"}

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

outerposition: вектор из четырех элементов, def. [-1 -1 -1 -1]

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

paperorientation: "landscape" | {"portrait"}

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

paperposition: вектор из четырех элементов, 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 будет иметь тот же размер, что и на экране, и будет центрирована на странице вывода. Установка paperpositionmode в "auto" не изменяет значение свойства paperposition.

papersize: двухэлементный вектор, 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 корневого объекта.

parent: графический дескриптор, по умолчанию 0

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

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

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

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

Название формы курсора мыши, связанной с холстом фигуры. Когда pointer равно "custom", форма определяется свойством pointershapecdata.

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

pointershapecdata: 16x16 или 32x32 матрица, по умолчанию 16x16 double

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

pointershapehotspot: вектор из двух элементов, по умолчанию [1 1]

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

position: вектор из четырех элементов, по умолчанию [300 200 560 420]

Укажите положение и размер холста фигуры. Четыре элемента вектора - координаты нижнего левого угла, ширина и высота фигуры. См. свойство единиц.

renderer: {"opengl"} | "painters"

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

renderermode: {"auto"} | "manual"

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

resize: "off" | {"on"}

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

resizefcn: строка | дескриптор функции, по умолчанию [](0x0)

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

selected: {"off"} | "on"

selectionhighlight: "off" | {"on"}

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

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

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

normal:

Левый щелчок.

alt:

Правый щелчок или Ctrl+левый щелчок.

extend:

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

open:

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

sizechangedfcn: строка | дескриптор функции, по умолчанию [](0x0)

Обработчик событий, вызываемый при изменении размера окна фигуры.

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

tag: строка, по умолчанию ""

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

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

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

type (только чтение): строка

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

uicontextmenu: графический дескриптор, по умолчанию [](0x0)

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

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

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

userdata: Любые данные Octave, по умолчанию [](0x0)

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

visible: "off" | {"on"}

Если visible равно "off", фигура не отображается на экране.

windowbuttondownfcn: строка | дескриптор функции, по умолчанию [](0x0)

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

windowbuttonmotionfcn: строка | дескриптор функции, по умолчанию [](0x0)

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

windowbuttonupfcn: строка | дескриптор функции, по умолчанию [](0x0)

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

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

windowkeypressfcn: строка | дескриптор функции, по умолчанию [](0x0)

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

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

windowkeyreleasefcn: строка | дескриптор функции, по умолчанию [](0x0)

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

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

windowscrollwheelfcn: строка | дескриптор функции, по умолчанию [](0x0)

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

VerticalScrollCount:

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

VerticalScrollAmount:

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

EventName:

Имя события, которое равно "WindowScrollWheel".

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

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

Стиль окна фигуры. Одно из следующих значений:

normal

Установить стиль окна как немодальный.

modal

Установить окно как модальное, так что оно будет оставаться поверх всех обычных фигур.

docked

Установка стиля окна как прикрепленного в настоящее время не прикрепляет окно.

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