Функции для работы с метками

  • ADD_LABEL
  • DELETE_LABEL
  • DELETE_ALL_LABELS
  • GET_LABEL_PARAMS
  • SET_LABEL_PARAMS
  •  

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

    ADD_LABEL

    Добавляет метку с заданными параметрами.

    DOUBLE ADD_LABEL (STRING tag, MAP label params)

    В окно, где отображен график с идентификатором «tag» добавляется метка. В случае успешного добавления функция возвращает идентификатор метки или (-1), если добавить метку не удалось.

    Формат массива MAP содержит следующие параметры метки:

    Параметр Тип Описание
    1 TEXT STRING Подпись метки (если подпись не требуется, то пустая строка)
    2 IMAGE_PATH STRING Путь к картинке, которая будет отображаться в качестве метки (пустая строка, если картинка не требуется)
    3 ALIGNMENT STRING Расположение картинки относительно текста (возможно 4 варианта: LEFT, RIGHT, TOP, BOTTOM)
    4 YVALUE DOUBLE Значение параметра на оси Y, к которому будет привязана метка
    5 DATE DOUBLE Дата в формате ГГГГММДД, к которой привязана метка
    6 TIME DOUBLE Время в формате ЧЧММСС, к которому будет привязана метка
    7 R DOUBLE Красная компонента цвета в формате RGB. Число в интервале [0;255]
    8 G DOUBLE Зеленая компонента цвета в формате RGB. Число в интервале [0;255]
    9 B DOUBLE Синяя компонента цвета в формате RGB. Число в интервале [0;255]
    10 TRANSPARENCY DOUBLE Прозрачность метки в процентах. Значение должно быть в промежутке [0; 100]
    11 TRANSPARENT_BACKGROUND DOUBLE Прозрачность метки. Возможные значения: «0» - прозрачность отключена, «1» - прозрачность включена
    12 FONT_FACE_NAME STRING Название шрифта (например "Arial")
    13 FONT_HEIGHT DOUBLE Размер шрифта
    14 HINT STRING Текст всплывающей подсказки

    Пример:

    ' 
    
    label_params=create_map()
    label_params=set_value(label_params,"TEXT", "Текст метки")
    label_params=set_value(label_params,"IMAGE_PATH", "image.bmp")
    label_params=set_value(label_params,"ALIGNMENT", "LEFT")
    label_params=set_value(label_params,"YVALUE", 2000)
    label_params=set_value(label_params,"DATE", 20080616)
    label_params=set_value(label_params,"TIME", 220000)
    label_params=set_value(label_params,"R", 0)
    label_params=set_value(label_params,"G", 0)
    label_params=set_value(label_params,"B", 200)
    label_params=set_value(label_params,"TRANSPARENCY", 10)
    label_params=set_value(label_params,"FONT_FACE_NAME", "Tahoma")
    label_params=set_value(label_params,"FONT_HEIGHT", 12)
    label_params=set_value(label_params,"HINT", "Подсказка")
    id=ADD_LABEL("ALL", label_params)
    '

    Результат представляется следующим образом: на графике с идентификатором «ALL» будет добавлена метка с параметрами, указанными в массиве label_params.

    DELETE_LABEL

    Удаляет метку с заданными параметрами.

    DOUBLE DELETE_LABEL(STRING tag, DOUBLE id)

    Удаляет метку с графика с текстовым идентификатором «tag» по заданному идентификатору id. В случае успешного удаления возвращает 1, в случае неудачи 0.

    Пример:

    ' 
    
    err=DELETE_LABEL("ALL", id)
    '

    Результат действия функции будет удаление метки на графике с идентификатором "ALL"

    DELETE_ALL_LABELS

    Команда удаляет все метки на диаграмме с указанным графиком.

    DOUBLE DELETE_ALL_LABELS(STRING tag)

    Удаляет все нанесенные метки с диаграммы, содержащей график с идентификатором tag. Если на этой диаграмме отображаются графики с разными идентификаторами, то этой командой будут удалены метки со всех графиков, а не только с указанного графика.

    Пример:

    ' 
    
    err=DELETE_ALL_LABELS("ALL")
    '

    Результатом действия функции будет удаление всех меток на графике.

    GET_LABEL_PARAMS

    Команда позволяет получить параметры меток.

    MAP GET_LABEL_PARAMS(STRING tag, DOUBLE id)

    Возвращает параметры метки с указанным идентификатором; если метка с указанным идентификатором не существует - возвращается пустой MAP.

    Пример:

    ' 
    
    new_params=GET_LABEL_PARAMS("ALL", id)
    '

    Разультатом действия является получение данных метки. Если такой метки не существует, то возвратившиеся значения будут пустыми.

    SET_LABEL_PARAMS

    Функция задает параметры для метки с указанным идентификатором.

    DOUBLE SET_LABEL_PARAMS(STRING tag, DOUBLE id, MAP new label params)

    Она позволяет задать новые параметры для метки. В случае успешного обновления параметров функция возвращает 1, в случае неудачи 0.

    Пример:

    ' 
    
    err=SET_LABEL_PARAMS("ALL", id, label_params)
    '

    Результатом действия функции будет измение существующих параметров на заданные функцией.