Last updated

API / geotoolkit / util / stream / StringStream / StringStream

Class: StringStream

stream.StringStream.StringStream

Defines representation memory string stream

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new StringStream(features)

new StringStream(features?)

Parameters

Name Type Description
Optional featuresstringoptional. A comma-separated list of items, no whitespaces, see https://www.w3schools.com/jsref/met_win_open.asp
Methods

close

close(): StringStream

Close stream

Returns

StringStream

Implementation of

IWritable.close


dispose

dispose(): void

Dispose

Returns

void

Implementation of

IWritable.dispose


getClassName

getClassName(): string

Returns

string


getContent

getContent(): Uint8Array

Gets stream content

Returns

Uint8Array

Implementation of

IWritable.getContent


getWindowFeatures

getWindowFeatures(): string

Returns window features

Returns

string


out

out(str): number

write the data into the file

Parameters

Name Type Description
strstringstring to be saved

Returns

number

offset the offset

Implementation of

IWritable.out


save

save(name?, save?): void

Save stream

Parameters

Name Type Description
Optional namestringthe name of the file to be created
Optional savebooleanflag to save the stream directly to file or open dialog

Returns

void

Implementation of

IWritable.save


setSaveOptions

setSaveOptions(options?): StringStream

Set saving options

Parameters

Name Type Description
Optional optionsSavingOptionsoptions

Returns

StringStream

this


setWindowFeatures

setWindowFeatures(features): StringStream

Sets window features

Parameters

Name Type Description
featuresstringa comma-separated list of items, no whitespaces, see https://www.w3schools.com/jsref/met_win_open.asp

Returns

StringStream

this


getClassName

Static getClassName(): string

Returns

string


save

Static save(options, content): void

Save content

Parameters

Name Type Description
optionsSavingOptionsoptions
contentstringcontent

Returns

void