PSSVG

SVG.discard

Synopsis

Creates SVG discard elements


Description

The <discard> SVG element allows authors to specify the time at which particular elements are to be discarded, thereby reducing the resources required by an SVG user agent. This is particularly useful to help SVG viewers conserve memory while displaying long-running documents.

The <discard> element may occur wherever the animate element may.



Parameters

Content

The Contents of the discard element

Type Required Position PipelineInput Aliases
[Object] false 1 true (ByValue, ByPropertyName) InputObject
Text
InnerText
Contents

Data

A dictionary containing data. This data will be embedded in data- attributes.

Type Required Position PipelineInput Aliases
[IDictionary] false named true (ByPropertyName) DataAttribute
DataAttributes

On

A dictionary or object containing event handlers. Each key or property name will be the name of the event Each value will be the handler.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

Attribute

A dictionary of attributes. This can set any attribute not exposed in other parameters.

Type Required Position PipelineInput Aliases
[IDictionary] false named true (ByPropertyName) SVGAttributes
SVGAttribute

Begin

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

Href

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

RequiredFeatures

The requiredFeatures attribute takes a list of feature strings, with the individual strings separated by white space. It determines whether or not all of the named features are supported by the browser; if all of them are supported, the attribute evaluates to true end the element is rendered; otherwise, the attribute evaluates to false and the current element and its children are skipped and thus will not be rendered. This provides a way to design SVG that gracefully falls back when features aren’t available.

If the attribute is not present, then its implicit evaluated value is true. If a null string or empty string value is given to attribute requiredFeatures, the attribute is evaluate to false.

requiredFeatures is often used in conjunction with the switch element. If requiredFeatures is used in other situations, it represents a simple switch on the given element whether to render the element or not.

To detect availability of an SVG feature from script, there is the (also deprecated) DOMImplementation.hasFeature() method.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

SystemLanguage

The systemLanguage attribute represents a list of supported language tags. This list is matched against the language defined in the user preferences.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

Id

The id attribute assigns a unique name to an element.

You can use this attribute with any SVG element.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

Lang

The lang attribute specifies the primary language used in contents and attributes containing text content of particular elements.

There is also an xml:lang attribute (with namespace). If both of them are defined, the one with namespace is used and the one without is ignored.

In SVG 1.1 there was a lang attribute defined with a different meaning and only applying to glyph elements. That attribute specified a list of languages according to . The glyph was meant to be used if the xml:lang attribute exactly matched one of the languages given in the value of this parameter, or if the xml:lang attribute exactly equaled a prefix of one of the languages given in the value of this parameter such that the first tag character following the prefix was “-“.

You can use this attribute with any SVG element.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

Tabindex

The tabindex attribute allows you to control whether an element is focusable and to define the relative order of the element for the purposes of sequential focus navigation.

You can use this attribute with any SVG element.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

XmlBase

The xml:base attribute specifies a base IRI other than the base IRI of the document or external entity.

You can use this attribute with any SVG element.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

XmlLang

The xml:lang attribute specifies the primary language used in contents and attributes containing text content of particular elements.

It is a universal attribute allowed in all XML dialects to mark up the natural human language that an element contains.

There is also a lang attribute (without namespace). If both of them are defined, the one with namespace is used and the one without is ignored.

You can use this attribute with any SVG element.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

XmlSpace

SVG supports the built-in XML xml:space attribute to handle whitespace characters inside elements. Child elements inside an element may also have an xml:space attribute that overrides the parent’s one.

Note: Instead of using the xml:space attribute, use the white-space CSS property.

This attribute influences how browsers parse text content and therefore changes the way the DOM is built. Therefore, changing this attribute’s value through the DOM API may have no effect.

You can use this attribute with any SVG element.

Type Required Position PipelineInput
[Object] false named true (ByPropertyName)

Outputs


Syntax

SVG.discard [[-Content] <Object>] [-Data <IDictionary>] [-On <Object>] [-Attribute <IDictionary>] [-Begin <Object>] [-Href <Object>] [-RequiredFeatures <Object>] [-SystemLanguage <Object>] [-Id <Object>] [-Lang <Object>] [-Tabindex <Object>] [-XmlBase <Object>] [-XmlLang <Object>] [-XmlSpace <Object>] [<CommonParameters>]