Platforms to show: All Mac Windows Linux Cross-Platform

Back to NSImageSymbolConfigurationMBS class.

NSImageSymbolConfigurationMBS.available as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Whether the class is available.

Returns true on macOS 11.0 or later.

NSImageSymbolConfigurationMBS.configurationPreferringMulticolor as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a configuration that specifies that the symbol should prefer its multicolor variant if one exists.

You can combine this configuration with one of the palette-based configurations. In that case, the symbol uses the multicolor variant if one exists; otherwise the symbol uses the palette version.
If the symbol supports neither, the symbol uses the monochrome (templated) symbol.

NSImageSymbolConfigurationMBS.configurationWithHierarchicalColor(hierarchicalColor as NSColorMBS) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a hierarchical color configuration using the color you specify.

This method creates a color scheme based on a single color. The system reduces the intensity of the base color to create the secondary and tertiary colors.
When combining this with another configuration, the last configuration overrides existing values.
If the symbol doesn’t have a palette variant, this color configuration doesn’t have an effect, so the symbol uses the monochrome (templated) symbol.

NSImageSymbolConfigurationMBS.configurationWithPaletteColors(paletteColors() as NSColorMBS) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a color configuration by specifying a palette of colors.
Example
// shows red colored trash can
Dim colors() As NSColorMBS
colors.Append NSColorMBS.redColor
Dim config As NSImageSymbolConfigurationMBS = NSImageSymbolConfigurationMBS.configurationWithPaletteColors(colors)
Dim n As NSImageMBS = NSImageMBS.imageWithSystemSymbolName("trash")
Dim o As NSImageMBS = n.imageWithSymbolConfiguration(config)

Backdrop = o.CopyPictureWithAlpha

The system applies the colors sequentially per layer — the first color for the first layer, and the second color for the second layer. This is independent of the hierarchy level of the layer.
When you combine this with another configuration to create a palette, the last configuration overrides any existing color configuration.
If the symbol doesn’t have a palette variant, this color configuration doesn’t have an effect, so the symbol uses the monochrome (templated) symbol.

NSImageSymbolConfigurationMBS.configurationWithPointSize(pointSize as Double, weight as Double) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a symbol configuration with the specified point size and font weight.

See also:

NSImageSymbolConfigurationMBS.configurationWithPointSize(pointSize as Double, weight as Double, SymbolScale as Integer) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a symbol configuration with the specified point size, font weight, and symbol scale.

See also:

NSImageSymbolConfigurationMBS.configurationWithScale(SymbolScale as Integer) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a symbol configuration using the scale you specify.
Example
Dim config As NSImageSymbolConfigurationMBS = NSImageSymbolConfigurationMBS.configurationWithScale(NSImageSymbolConfigurationMBS.kSymbolScaleLarge)
Dim n As NSImageMBS = NSImageMBS.imageWithSystemSymbolName("trash")
Dim o As NSImageMBS = n.imageWithSymbolConfiguration(config)

Backdrop = o.CopyPictureWithAlpha

NSImageSymbolConfigurationMBS.configurationWithTextStyle(TextStyle as Integer) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a symbol configuration with the specified text style.

See also:

NSImageSymbolConfigurationMBS.configurationWithTextStyle(TextStyle as Integer, SymbolScale as Integer) as NSImageSymbolConfigurationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a symbol configuration with the specified text style and symbol scale.

See also:

NSImageSymbolConfigurationMBS.NSFontTextStyleBody as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for body text.

NSImageSymbolConfigurationMBS.NSFontTextStyleCallout as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for callouts.

NSImageSymbolConfigurationMBS.NSFontTextStyleCaption1 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for standard captions.

NSImageSymbolConfigurationMBS.NSFontTextStyleCaption2 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for alternate captions.

NSImageSymbolConfigurationMBS.NSFontTextStyleFootnote as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use in footnotes.

NSImageSymbolConfigurationMBS.NSFontTextStyleHeadline as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for headings.

NSImageSymbolConfigurationMBS.NSFontTextStyleLargeTitle as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for titles.

NSImageSymbolConfigurationMBS.NSFontTextStyleSubheadline as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for subheadings.

NSImageSymbolConfigurationMBS.NSFontTextStyleTitle1 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for first-level hierarchical headings.

NSImageSymbolConfigurationMBS.NSFontTextStyleTitle2 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for second-level hierarchical headings.

NSImageSymbolConfigurationMBS.NSFontTextStyleTitle3 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Drawing MBS MacBase Plugin 22.1 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the text style constants.

The font you use for third-level hierarchical headings.

The items on this page are in the following plugins: MBS MacBase Plugin.


The biggest plugin in space...