DisplayOptions Type

Constructors

Constructor Description

DisplayOptions()

Full Usage: DisplayOptions()

Returns: DisplayOptions
Returns: DisplayOptions

Static members

Static member Description

DisplayOptions.addAdditionalHeadTags additionalHeadTags

Full Usage: DisplayOptions.addAdditionalHeadTags additionalHeadTags

Parameters:
    additionalHeadTags : XmlNode list

Returns: DisplayOptions -> DisplayOptions
additionalHeadTags : XmlNode list
Returns: DisplayOptions -> DisplayOptions

DisplayOptions.addDescription description

Full Usage: DisplayOptions.addDescription description

Parameters:
Returns: DisplayOptions -> DisplayOptions
description : XmlNode list
Returns: DisplayOptions -> DisplayOptions

DisplayOptions.getAdditionalHeadTags displayOpts

Full Usage: DisplayOptions.getAdditionalHeadTags displayOpts

Parameters:
Returns: XmlNode list
displayOpts : DisplayOptions
Returns: XmlNode list

DisplayOptions.getCytoscapeReference displayOpts

Full Usage: DisplayOptions.getCytoscapeReference displayOpts

Parameters:
Returns: CytoscapeJSReference
displayOpts : DisplayOptions
Returns: CytoscapeJSReference

DisplayOptions.getDescription displayOpts

Full Usage: DisplayOptions.getDescription displayOpts

Parameters:
Returns: XmlNode list
displayOpts : DisplayOptions
Returns: XmlNode list

DisplayOptions.init (?AdditionalHeadTags, ?Description, ?CytoscapeJSReference)

Full Usage: DisplayOptions.init (?AdditionalHeadTags, ?Description, ?CytoscapeJSReference)

Parameters:
    ?AdditionalHeadTags : XmlNode list - Additional tags that will be included in the document's head
    ?Description : XmlNode list - HTML tags that appear below the chart in HTML docs
    ?CytoscapeJSReference : CytoscapeJSReference - Sets how cytoscape.js is referenced in the head of html docs. When CDN, a script tag that references a CDN is included in the output. When Full, a script tag containing the cytoscape.js source code (~400KB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline

Returns: DisplayOptions

Returns a new DisplayOptions object with the given styles

?AdditionalHeadTags : XmlNode list

Additional tags that will be included in the document's head

?Description : XmlNode list

HTML tags that appear below the chart in HTML docs

?CytoscapeJSReference : CytoscapeJSReference

Sets how cytoscape.js is referenced in the head of html docs. When CDN, a script tag that references a CDN is included in the output. When Full, a script tag containing the cytoscape.js source code (~400KB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline

Returns: DisplayOptions

DisplayOptions.initCDNOnly ()

Full Usage: DisplayOptions.initCDNOnly ()

Returns: DisplayOptions

Returns a DisplayOptions Object with the cdn set to Globals.CYTOSCAPEJS_VERSION

Returns: DisplayOptions

DisplayOptions.initDefault ()

Full Usage: DisplayOptions.initDefault ()

Returns: DisplayOptions

Returns a DisplayOptions Object with the cdn set to Globals.CYTOSCAPEJS_VERSION and additional head tags

Returns: DisplayOptions

DisplayOptions.setAdditionalHeadTags additionalHeadTags

Full Usage: DisplayOptions.setAdditionalHeadTags additionalHeadTags

Parameters:
    additionalHeadTags : XmlNode list

Returns: DisplayOptions -> DisplayOptions
additionalHeadTags : XmlNode list
Returns: DisplayOptions -> DisplayOptions

DisplayOptions.setCytoscapeReference cytoscapeReference

Full Usage: DisplayOptions.setCytoscapeReference cytoscapeReference

Parameters:
Returns: DisplayOptions -> DisplayOptions
cytoscapeReference : CytoscapeJSReference
Returns: DisplayOptions -> DisplayOptions

DisplayOptions.setDescription description

Full Usage: DisplayOptions.setDescription description

Parameters:
Returns: DisplayOptions -> DisplayOptions
description : XmlNode list
Returns: DisplayOptions -> DisplayOptions

DisplayOptions.style (?AdditionalHeadTags, ?Description, ?CytoscapeJSReference)

Full Usage: DisplayOptions.style (?AdditionalHeadTags, ?Description, ?CytoscapeJSReference)

Parameters:
    ?AdditionalHeadTags : XmlNode list - Additional tags that will be included in the document's head
    ?Description : XmlNode list - HTML tags that appear below the chart in HTML docs
    ?CytoscapeJSReference : CytoscapeJSReference - Sets how cytoscape.js is referenced in the head of html docs. When CDN, a script tag that references a CDN is included in the output. When Full, a script tag containing the cytoscape.js source code (~400KB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline

Returns: DisplayOptions -> DisplayOptions

Returns a function sthat applies the given styles to a DisplayOptions object

?AdditionalHeadTags : XmlNode list

Additional tags that will be included in the document's head

?Description : XmlNode list

HTML tags that appear below the chart in HTML docs

?CytoscapeJSReference : CytoscapeJSReference

Sets how cytoscape.js is referenced in the head of html docs. When CDN, a script tag that references a CDN is included in the output. When Full, a script tag containing the cytoscape.js source code (~400KB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline

Returns: DisplayOptions -> DisplayOptions

DisplayOptions.tryGetAdditionalHeadTags displayOpts

Full Usage: DisplayOptions.tryGetAdditionalHeadTags displayOpts

Parameters:
Returns: XmlNode list option
displayOpts : DisplayOptions
Returns: XmlNode list option

DisplayOptions.tryGetCytoscapeReference displayOpts

Full Usage: DisplayOptions.tryGetCytoscapeReference displayOpts

Parameters:
Returns: CytoscapeJSReference option
displayOpts : DisplayOptions
Returns: CytoscapeJSReference option

DisplayOptions.tryGetDescription displayOpts

Full Usage: DisplayOptions.tryGetDescription displayOpts

Parameters:
Returns: XmlNode list option
displayOpts : DisplayOptions
Returns: XmlNode list option