Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

TopologyIconArtwork

Namespace ChartForgeX.Topology
Assembly ChartForgeX
Modifiers sealed

Describes optional external artwork for a topology icon.

Inheritance

  • Object
  • TopologyIconArtwork

Usage

Explore 13 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 7

Constructors

public TopologyIconArtwork() #

Methods

public static TopologyIconArtwork Image(String href, String svgViewBox = "0 0 24 24") #
Returns: TopologyIconArtwork

Creates image artwork.

Parameters

href System.String requiredposition: 0
svgViewBox System.String = "0 0 24 24" optionalposition: 1
public static TopologyIconArtwork InlineSvg(String svgBody, String svgViewBox = "0 0 24 24") #
Returns: TopologyIconArtwork

Creates inline SVG artwork.

Parameters

svgBody System.String requiredposition: 0
svgViewBox System.String = "0 0 24 24" optionalposition: 1
public static Boolean IsSafeAssetPath(String? path) #
Returns: Boolean

Returns whether an artwork path is safe enough for pack-local file resolution.

Parameters

path System.String? requiredposition: 0
public static Boolean IsSafeImageHref(String? href) #
Returns: Boolean

Returns whether an image href is safe enough for report embedding.

Parameters

href System.String? requiredposition: 0
public static Boolean IsSafeSvgFragment(String? svgBody) #
Returns: Boolean

Returns whether an inline SVG fragment is safe enough for report embedding.

Parameters

svgBody System.String? requiredposition: 0
public static TopologyIconArtwork SvgFile(String path, String svgViewBox = "0 0 24 24", String? previewPath = null) #
Returns: TopologyIconArtwork

Creates SVG file artwork.

Parameters

path System.String requiredposition: 0
svgViewBox System.String = "0 0 24 24" optionalposition: 1
previewPath System.String? = null optionalposition: 2
public TopologyIconArtwork WithPreserveAspectRatio(String preserveAspectRatio) #
Returns: TopologyIconArtwork

Sets the preserveAspectRatio value used when rendering SVG or image artwork.

Parameters

preserveAspectRatio System.String requiredposition: 0

Properties

public String SvgViewBox { get; set; } #

Gets or sets an SVG viewBox used for inline SVG artwork.

public String? SvgBody { get; set; } #

Gets or sets trusted inline SVG fragment markup, such as path, rect, circle, and linearGradient elements.

public String? SvgPath { get; set; } #

Gets or sets a relative or host-managed path to an SVG file.

public String? PreviewPath { get; set; } #

Gets or sets a relative or host-managed path to a generated preview image.

public String? ImageHref { get; set; } #

Gets or sets an image href, usually a data URI or host-managed URL.

public String PreserveAspectRatio { get; set; } #

Gets or sets the preserveAspectRatio value used when rendering SVG or image artwork.

public Boolean HasSvgBody { get; } #

Gets whether this artwork defines an inline SVG fragment.

public Boolean HasSvgPath { get; } #

Gets whether this artwork references an SVG file.

public Boolean HasPreviewPath { get; } #

Gets whether this artwork references a preview image.

public Boolean HasImageHref { get; } #

Gets whether this artwork defines an image href.

public Boolean IsSafe { get; } #

Gets whether inline SVG artwork can be embedded safely.