Edit

Share via

Excel.ChartMapOptions class

Package:
excel

Encapsulates the properties for a region map chart.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
labelStrategy

Specifies the series map labels strategy of a region map chart.
level

Specifies the series mapping level of a region map chart.
projectionType

Specifies the series projection type of a region map chart.

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.
toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.ChartMapOptions object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartMapOptionsData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

labelStrategy

Specifies the series map labels strategy of a region map chart.

labelStrategy: Excel.ChartMapLabelStrategy | "None" | "BestFit" | "ShowAll";

Property Value

Excel.ChartMapLabelStrategy | "None" | "BestFit" | "ShowAll"

Remarks

[ API set: ExcelApi 1.9 ]

level

Specifies the series mapping level of a region map chart.

level: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | "World";

Property Value

Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | "World"

Remarks

[ API set: ExcelApi 1.9 ]

projectionType

Specifies the series projection type of a region map chart.

projectionType: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers";

Property Value

Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"

Remarks

[ API set: ExcelApi 1.9 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.ChartMapOptionsLoadOptions): Excel.ChartMapOptions;

Parameters

options
Excel.Interfaces.ChartMapOptionsLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartMapOptions

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.ChartMapOptions;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.ChartMapOptions

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartMapOptions;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.ChartMapOptions

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ChartMapOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.ChartMapOptionsUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartMapOptions): void;

Parameters

properties
Excel.ChartMapOptions

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.ChartMapOptions object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartMapOptionsData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartMapOptionsData;

Returns

Excel.Interfaces.ChartMapOptionsData