API Reference
ChartBrandKit
Defines reusable brand tokens that can be applied to charts, grids, and themes.
Inheritance
- Object
- ChartBrandKit
Usage
Explore 18 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.
Returned or exposed by 13
- Method ChartBrandKit.Accessible
- Method ChartBrandKit.Create
- Method ChartBrandKit.Editorial
- Method ChartBrandKit.Executive
- Method ChartBrandKit.PeopleInfographic
- Method ChartBrandKit.Product
- Method ChartBrandKit.WithFontFamily
- Method ChartBrandKit.WithGuideColors
- Method ChartBrandKit.WithPalette
- Method ChartBrandKit.WithSemanticColors
- Method ChartBrandKit.WithSurfaceColors
- Method ChartBrandKit.WithSurfaceStyle
- Method ChartBrandKit.WithTextColors
Accepted by parameters 5
- Method ChartExtensions.WithBrandKit
- Method ChartExtensions.WithBrandKit``1
- Extension method Chart.WithBrandKit
- Extension method ChartGrid.WithBrandKit
- Method ChartTheme.WithBrandKit
Constructors
public ChartBrandKit() #Methods
public static ChartBrandKit Accessible() #ChartBrandKitCreates a high-contrast colorblind-friendly brand kit.
Returns
An accessible brand kit.
public ChartTheme ApplyTo(ChartTheme theme) #ChartThemeApplies this brand kit to a theme.
Parameters
- theme ChartForgeX.Themes.ChartTheme
- The theme to update.
Returns
The updated theme.
public static ChartBrandKit Create() #ChartBrandKitCreates an empty brand kit.
Returns
A brand kit.
public static ChartBrandKit Editorial() #ChartBrandKitCreates a publication-oriented editorial brand kit.
Returns
An editorial brand kit.
public static ChartBrandKit Executive() #ChartBrandKitCreates a restrained executive report brand kit.
Returns
An executive brand kit.
public static ChartBrandKit PeopleInfographic() #ChartBrandKitCreates a clean cyan and magenta people-infographic brand kit.
Returns
A people-infographic brand kit.
public static ChartBrandKit Product() #ChartBrandKitCreates a vivid product-dashboard brand kit.
Returns
A product brand kit.
public ChartBrandKit WithFontFamily(String fontFamily) #ChartBrandKitApplies a CSS font-family stack.
Parameters
- fontFamily System.String
- The CSS font-family stack.
Returns
The current brand kit.
public ChartBrandKit WithGuideColors(ChartColor grid, ChartColor axis) #ChartBrandKitApplies grid and axis guide colors.
Parameters
- grid ChartForgeX.Primitives.ChartColor
- The grid line color.
- axis ChartForgeX.Primitives.ChartColor
- The axis line color.
Returns
The current brand kit.
public ChartBrandKit WithPalette(params ChartColor[] colors) #ChartBrandKitApplies a brand palette.
Parameters
- colors ChartForgeX.Primitives.ChartColor[]
- The palette colors.
Returns
The current brand kit.
public ChartBrandKit WithPalette(params String[] colors) #ChartBrandKitApplies a brand palette from hexadecimal color strings.
Parameters
- colors System.String[]
- The color strings in #RGB, #RGBA, #RRGGBB, or #RRGGBBAA notation.
Returns
The current brand kit.
public ChartBrandKit WithSemanticColors(ChartColor positive, ChartColor warning, ChartColor negative) #ChartBrandKitApplies semantic status colors.
Parameters
- positive ChartForgeX.Primitives.ChartColor
- The positive status color.
- warning ChartForgeX.Primitives.ChartColor
- The warning status color.
- negative ChartForgeX.Primitives.ChartColor
- The negative status color.
Returns
The current brand kit.
public ChartBrandKit WithSurfaceColors(ChartColor background, ChartColor cardBackground, ChartColor plotBackground, ChartColor cardBorder, ChartColor plotBorder) #ChartBrandKitApplies background and surface colors.
Parameters
- background ChartForgeX.Primitives.ChartColor
- The full chart background.
- cardBackground ChartForgeX.Primitives.ChartColor
- The outer card background.
- plotBackground ChartForgeX.Primitives.ChartColor
- The plot area background.
- cardBorder ChartForgeX.Primitives.ChartColor
- The outer card border.
- plotBorder ChartForgeX.Primitives.ChartColor
- The plot area border.
Returns
The current brand kit.
public ChartBrandKit WithSurfaceStyle(ChartSurfaceStyle style) #ChartBrandKitApplies a surface style preset.
Parameters
- style ChartForgeX.Themes.ChartSurfaceStyle
- The surface style preset.
Returns
The current brand kit.
public ChartBrandKit WithTextColors(ChartColor text, ChartColor mutedText) #ChartBrandKitApplies primary and secondary text colors.
Parameters
- text ChartForgeX.Primitives.ChartColor
- The primary text color.
- mutedText ChartForgeX.Primitives.ChartColor
- The secondary text color.
Returns
The current brand kit.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?