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"). См. раздел обратные вызовы.

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

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

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

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

clipping: "off" | {"on"}

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

closerequestfcn: строка | обработчик функции, def. "closereq"

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

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

color: цвет, def. [1 1 1]

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

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

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

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

Дескриптор объекта uicontextmenu, который в настоящее время связан с этим объектом figure.

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

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

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

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.

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

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.

innerposition: def. [300 200 560 420]

integerhandle: "off" | {"on"}

Присваивает следующую наименьшую свободно используемую целую часть, как номер figure.

interruptible: "off" | {"on"}

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

inverthardcopy: "off" | {"on"}

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

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

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

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

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

Character:

ASCII-код нажатой клавиши

Key:

Строчное представление нажатой клавиши

Modifier:

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

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

menubar: {"figure"} | "none"

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

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

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

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

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

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

numbertitle: "off" | {"on"}

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

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

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:

Shitf+Левый щелчок, Средний щелчок или сочетание Левого и Правого щелчков.

open:

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

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

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

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

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

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

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

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

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

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

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".

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

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

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

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

normal

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

modal

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

docked

Установка стиля окна как прикреплённого (докированного) в настоящий момент не прикрепляет окно.

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