U.S. flag

An official website of the United States government

NCBI-TreeViewObjects DEFINITIONS ::=

BEGIN

IMPORTS BioTreeContainer FROM NCBI-BioTree
        Seq-id FROM NCBI-Seqloc;

-- ==========================================================================
--
-- Screen area description
--
-- ==========================================================================


TV-AreaDesc ::= SEQUENCE {
    -- (x, y) is the coordinate of the node corner closest to the start of coordinate axes (top left if looking at the screen)
    x INTEGER,
    y INTEGER,

    -- width, height are in the direction further along the axes from the start
    width INTEGER,
    height INTEGER,

    -- upper left corner of first character of the label in screen (top is 0) coordinates
    labelx INTEGER OPTIONAL,
    labely INTEGER OPTIONAL,

    -- width, height and rotation angle in radians of the label
    labelwidth INTEGER OPTIONAL,
    labelheight INTEGER OPTIONAL,
    labelangle REAL OPTIONAL 
}


-- ==========================================================================
--
-- Tree node description
--
-- ==========================================================================

-- BioTreeContainer features requested by user

TV-TreeNodeFeat ::= SEQUENCE {
    feat-name   VisibleString,
    feat-value  VisibleString
}

TV-TreeNodeDesc ::= SEQUENCE {
    nodeid  INTEGER,
    color   VisibleString OPTIONAL,
    label   VisibleString OPTIONAL,
    seq-id  VisibleString OPTIONAL,
    seq-title VisibleString OPTIONAL,
    accession-nbr VisibleString OPTIONAL,
    is-leaf BOOLEAN OPTIONAL,
    features SET OF TV-TreeNodeFeat OPTIONAL,
    bounds  TV-AreaDesc OPTIONAL
}

-- ==========================================================================
--
-- Rendering parameters
--
-- ==========================================================================

TV-RenderingParameters ::= SEQUENCE {
    width   INTEGER OPTIONAL,
    height  INTEGER OPTIONAL,
    maxwidth INTEGER OPTIONAL,
    maxheight INTEGER OPTIONAL,
    computedwidth INTEGER OPTIONAL,
    computedheight INTEGER OPTIONAL,

    -- Scale is the horizontal distance for 100 pixels in the output image
    -- where distance is based on the 'dist' parameter in the tree.
    -- It is only provided for trees with the 'dist' attribute that are 
    -- rendered in a layout that supports distance (rectangular or radial) 
    -- and distmode is not set to false (it defaults to true)
    scale REAL OPTIONAL,
    -- This is the number displayed on the scale bar for the returned image
    -- The length of the scale bar will be 100*(dispalyscale/scale)
    displayscale REAL OPTIONAL
    
}

-- ==========================================================================
--
-- Whole tree image description
--
-- ==========================================================================

TV-TreeImgDesc ::= SEQUENCE {
    nodes   SET OF TV-TreeNodeDesc OPTIONAL,
    img-key VisibleString OPTIONAL,
    renderingparameters TV-RenderingParameters OPTIONAL,
    btc BioTreeContainer OPTIONAL,
    -- CTreeViewRendererException::EErrCode
    err-code INTEGER OPTIONAL,
    err-msg VisibleString OPTIONAL
}


END
Support Center

Last updated: 2014-07-09T14:27:55-04:00