DisplayOptions (Sigma.NET) | Sigma.NET

DisplayOptions Type

Namespace: Sigma.NET
Assembly: Sigma.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

I am displayotion.

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` - A list of XML nodes representing the additional head tags to add. Returns: `DisplayOptions -> DisplayOptions` A function that adds the additional head tags to the existing ones in the display options.	Adds additional head tags to the display options. additionalHeadTags : `XmlNode list` A list of XML nodes representing the additional head tags to add. Returns: `DisplayOptions -> DisplayOptions` A function that adds the additional head tags to the existing ones in the display options.
`DisplayOptions.addDescription description` Full Usage: `DisplayOptions.addDescription description` Parameters: description : `XmlNode list` - A list of XML nodes representing the description to add. Returns: `DisplayOptions -> DisplayOptions` A function that adds the description to the existing one in the display options.	Adds a description to the display options. description : `XmlNode list` A list of XML nodes representing the description to add. Returns: `DisplayOptions -> DisplayOptions` A function that adds the description to the existing one in the display options.
`DisplayOptions.getAdditionalHeadTags displayOpts` Full Usage: `DisplayOptions.getAdditionalHeadTags displayOpts` Parameters: displayOpts : `DisplayOptions` - The display options object. Returns: `XmlNode list` A list of XML nodes representing the additional head tags, or an empty list if not found.	Gets the additional head tags from the display options. displayOpts : `DisplayOptions` The display options object. Returns: `XmlNode list` A list of XML nodes representing the additional head tags, or an empty list if not found.
`DisplayOptions.getDescription displayOpts` Full Usage: `DisplayOptions.getDescription displayOpts` Parameters: displayOpts : `DisplayOptions` - The display options object. Returns: `XmlNode list` A list of XML nodes representing the description, or an empty list if not found.	Gets the description from the display options. displayOpts : `DisplayOptions` The display options object. Returns: `XmlNode list` A list of XML nodes representing the description, or an empty list if not found.
`DisplayOptions.getSigmaReference displayOpts` Full Usage: `DisplayOptions.getSigmaReference displayOpts` Parameters: displayOpts : `DisplayOptions` - The display options object. Returns: `JSlibReference` The JavaScript library reference for Sigma.js, or NoReference if not found.	Gets the Sigma.js reference from the display options. displayOpts : `DisplayOptions` The display options object. Returns: `JSlibReference` The JavaScript library reference for Sigma.js, or NoReference if not found.
`DisplayOptions.init (?AdditionalHeadTags, ?Description, ?SigmaJSRef)` Full Usage: `DisplayOptions.init (?AdditionalHeadTags, ?Description, ?SigmaJSRef)` 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 ?SigmaJSRef : `JSlibReference` 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 ?SigmaJSRef : `JSlibReference` Returns: `DisplayOptions`
`DisplayOptions.initCDNOnly ()` Full Usage: `DisplayOptions.initCDNOnly ()` Returns: `DisplayOptions`	Returns a DisplayOptions Object with the cdn set to Globals.SIGMAJS_VERSION and Globals.GRAPHOLOGY_VERSION Returns: `DisplayOptions`
`DisplayOptions.initDefault ()` Full Usage: `DisplayOptions.initDefault ()` Returns: `DisplayOptions`	Returns a DisplayOptions Object with the cdn set to Globals.SIGMAJS_VERSION and additional head tags Returns: `DisplayOptions`
`DisplayOptions.setAdditionalHeadTags additionalHeadTags` Full Usage: `DisplayOptions.setAdditionalHeadTags additionalHeadTags` Parameters: additionalHeadTags : `XmlNode list` - A list of XML nodes representing the additional head tags to set. Returns: `DisplayOptions -> DisplayOptions` A function that sets the additional head tags in the display options.	Sets additional head tags for the display options. additionalHeadTags : `XmlNode list` A list of XML nodes representing the additional head tags to set. Returns: `DisplayOptions -> DisplayOptions` A function that sets the additional head tags in the display options.
`DisplayOptions.setDescription description` Full Usage: `DisplayOptions.setDescription description` Parameters: description : `XmlNode list` - A list of XML nodes representing the description to set. Returns: `DisplayOptions -> DisplayOptions` A function that sets the description in the display options.	Sets a description for the display options. description : `XmlNode list` A list of XML nodes representing the description to set. Returns: `DisplayOptions -> DisplayOptions` A function that sets the description in the display options.
`DisplayOptions.setSigmaReference sigmaJSReference` Full Usage: `DisplayOptions.setSigmaReference sigmaJSReference` Parameters: sigmaJSReference : `JSlibReference` - The JavaScript library reference to set for Sigma.js. Returns: `DisplayOptions -> DisplayOptions` A function that sets the Sigma.js reference in the display options.	Sets the Sigma.js reference for the display options. sigmaJSReference : `JSlibReference` The JavaScript library reference to set for Sigma.js. Returns: `DisplayOptions -> DisplayOptions` A function that sets the Sigma.js reference in the display options.
`DisplayOptions.style (?AdditionalHeadTags, ?Description, ?SigmaJSRef)` Full Usage: `DisplayOptions.style (?AdditionalHeadTags, ?Description, ?SigmaJSRef)` 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 ?SigmaJSRef : `JSlibReference` 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 ?SigmaJSRef : `JSlibReference` Returns: `DisplayOptions -> DisplayOptions`
`DisplayOptions.tryGetAdditionalHeadTags displayOpts` Full Usage: `DisplayOptions.tryGetAdditionalHeadTags displayOpts` Parameters: displayOpts : `DisplayOptions` - The display options object. Returns: `XmlNode list option` An option containing a list of XML nodes if the additional head tags exist, or None.	Tries to get the additional head tags from the display options. displayOpts : `DisplayOptions` The display options object. Returns: `XmlNode list option` An option containing a list of XML nodes if the additional head tags exist, or None.
`DisplayOptions.tryGetDescription displayOpts` Full Usage: `DisplayOptions.tryGetDescription displayOpts` Parameters: displayOpts : `DisplayOptions` - The display options object. Returns: `XmlNode list option` An option containing a list of XML nodes if the description exists, or None.	Tries to get the description from the display options. displayOpts : `DisplayOptions` The display options object. Returns: `XmlNode list option` An option containing a list of XML nodes if the description exists, or None.
`DisplayOptions.tryGetSigmaReference displayOpts` Full Usage: `DisplayOptions.tryGetSigmaReference displayOpts` Parameters: displayOpts : `DisplayOptions` - The display options object. Returns: `JSlibReference option` An option containing the JavaScript library reference for Sigma.js, or None.	Tries to get the Sigma.js reference from the display options. displayOpts : `DisplayOptions` The display options object. Returns: `JSlibReference option` An option containing the JavaScript library reference for Sigma.js, or None.