Interface Options
===========================

#. Set user interface default options:

    .. code-block:: bash

        # Default kinetic drag setting
        omero config set omero.web.pathviewer.option.kinetic_drag true
        # Default setting for shape label visibility
        omero config set omero.web.pathviewer.option.hide_shape_labels true
        # Default setting for zoom center option
        omero config set omero.web.pathviewer.option.zoom_at_cursor true

#. Set user predefined ROI styles:

    .. code-block:: bash

        # Set predefined styles to an empty array.
        omero config set omero.web.pathviewer.styles '[]'
        # Add a predefined style to the list.
        omero config append omero.web.pathviewer.styles '{"label": "Red1", "fillcolor": "rgba(255,0,0,0.5)", "strokecolor": "rgba(255,0,0,1.0)", "fontcolor": "rgba(255,0,0,1.0)", "labelPosition": "left", "strokedash": "none", "fontsize": "12px"}'


    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | Predefined Style                                                                                                                                           |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | Style                 | Type                   | Example              | Description                                                                        |
    +=======================+========================+======================+====================================================================================+
    | label                 | string                 | Red ROI              | Label text for ROI. Can be any string.                                             |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | fillcolor             | string                 | rgba(255,0,0,0.8)    | ROI shaped fill color. Must be an rgba string.                                     |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | strokecolor           | string                 | rgba(255,0,0,1.0)    | Border color of ROI shape. Must be an rgba string.                                 |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | fontcolor             | string                 | red                  | Color used for label text. Can be a string of any valid css color string.          |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | labelPosition         | string                 | center               | ROI label position, one of "default", "center", "above", "below", "left", "right". |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | strokedash            | string                 | 2 5                  | Style of ROI border, one of "none", "2 5", "5", "1 0", "5 5 2 5".                  |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+
    | fontsize              | string                 | 12px                 | Font size of ROI label, one of "12px", "24px", "36px".                             |
    +-----------------------+------------------------+----------------------+------------------------------------------------------------------------------------+

    * rgba opacities must be a float. Also, the tens and tenths position must not be blank. e.g. 1.0 and 0.25

    ROI Dashed Stroke Key: ::

        none    ==>  ---------------
        2 5     ==>  · · · · · · · · · · · · ·
        5       ==>  - - - - - - - - - -
        1 0     ==>  — — — —
        5 5 2 5 ==>  - · - · - · - · - · -

    Example: ::

        {
            "label": "Green ROI",
            "fillcolor": "rgba(0,255,0,0.5)",
            "strokecolor": "rgba(0,255,0,1.0)",
            "fontcolor": "rgba(0,255,0,1.0)",
            "labelPosition": "center",
            "strokedash": "5",
            "fontsize": "24px"
        }